TCP socket. More...

#include <JTCPSocket.hh>

Inheritance diagram for JNET::JTCPSocket:

Public Member Functions
	JTCPSocket ()
	Default constructor.

	JTCPSocket (const int server)
	Constructor.

void	setNonBlocking (const bool on)
	Set non-blocking of I/O.

bool	getNonBlocking () const
	Get non-blocking of I/O.

void	setKeepIdle (const int t_s)
	Set the TCP idle time.

void	setKeepCnt (const int count)
	Set the TCP idle count.

void	setKeepIntvl (const int t_s)
	Set the TCP interval time.

void	setTcpNoDelay (const bool on)
	Set TCP no-delay.

bool	getTcpNoDelay () const
	Get TCP no-delay.

void	accept (const int server)
	Accept connection from a server.

void	connect (const int port)
	Connect to port on local host.

void	connect (const JHostname &hostname)
	Connect to port on specified host.

void	connect (const std::string &hostname, const int port)
	Connect to port on specified host.

void	connect (const int ip_number, const int port)
	Connect to port on specified host.

int	shutdown ()
	Shut down socket.

void	setKeepAlive (const bool on)
	Set keep alive of socket.

bool	getKeepAlive () const
	Get keep alive of socket.

void	setReuseAddress (const bool on)
	Set reuse address.

bool	getReuseAddress () const
	Get reuse address.

void	setReceiveBufferSize (const int size)
	Set receive buffer size.

int	getReceiveBufferSize () const
	Set receive buffer size.

void	setSendBufferSize (const int size)
	Set send buffer size.

int	getSendBufferSize () const
	Get send buffer size.

virtual int	read (char *buffer, const int length) override
	Read data from socket.

virtual int	write (const char *buffer, const int length) override
	Write data to socket.

int	close ()
	Close file.

bool	in_avail (JTimeval timeout=JTimeval::min()) const
	Check availability of input.

bool	out_avail (JTimeval timeout=JTimeval::min()) const
	Check availability of output.

virtual bool	good () const
	Check status.

virtual bool	fail () const
	Check status.

virtual bool	bad () const
	Check status.

virtual bool	eof () const
	Check end of file.

bool	less (const JAbstractFile &file) const
	Less than operation.

int	getFileDescriptor () const
	Get file descriptor.

void	setFileDescriptor (const int file)
	Set file descriptor.

bool	is_open () const
	Get open status.

const sockaddr *	getSockaddr () const
	Get sockaddr.

sockaddr *	getSockaddr ()
	Get sockaddr.

int	getFamily () const
	Get family.

void	setFamily (const int family)
	Set family.

std::string	getHostname () const
	Get host name.

int	getIPnumber () const
	Get IP number.

void	setIPnumber (const int ip_number)
	Set IP number.

void	setIPnumber ()
	Set any IP number.

int	getPort () const
	Get port number.

void	setPort (const int port)
	Set port number.

Static Public Member Functions
static const int	getDefaultBufferSize ()
	Default socket buffer size to be used on this system.

static int	sizeOf ()
	Get size of object.

Static Public Attributes
static const int	FILE_CLOSED = -1

Protected Member Functions
template<class T >
void	setOption (const int level, const int option, const T value)
	Set socket option.

template<class T >
T	getOption (const int level, const int option) const
	Get socket option.

Protected Attributes
int	fileDescriptor

Private Attributes
int	result

Detailed Description

TCP socket.

Definition at line 28 of file JTCPSocket.hh.

Constructor & Destructor Documentation

◆ JTCPSocket() [1/2]

JNET::JTCPSocket::JTCPSocket ( )

inline

Default constructor.

Definition at line 35 of file JTCPSocket.hh.

                 :
      JSocket(AF_INET, SOCK_STREAM)
    {}

◆ JTCPSocket() [2/2]

JNET::JTCPSocket::JTCPSocket ( const int server )

inline

Constructor.

Parameters

server file descriptor of TCP server socket

Definition at line 45 of file JTCPSocket.hh.

    {
      accept(server);
    }

Member Function Documentation

◆ setNonBlocking()

void JNET::JTCPSocket::setNonBlocking ( const bool on )

inline

Set non-blocking of I/O.

Parameters

on	true to enable non-blocking; false to disable

Definition at line 56 of file JTCPSocket.hh.

    {
      const int flags = fcntl(getFileDescriptor(), F_GETFL, -1);
      const int mask  = FNDELAY;
 
      if (flags == -1) {
        THROW(JSocketException, "Get socket option failed " << errno);
      }
 
      if (((flags & mask) != mask &&  on) ||
          ((flags & mask) != 0    && !on) ) {
 
        if (fcntl(getFileDescriptor(), F_SETFL, flags ^ mask) < 0) {
          THROW(JSocketException, "Set socket option failed " << errno);
        }
      }
    }

◆ getNonBlocking()

bool JNET::JTCPSocket::getNonBlocking ( ) const

inline

Get non-blocking of I/O.

Returns: true if enabled non-blocking; else false

Definition at line 80 of file JTCPSocket.hh.

    {
      const int flags = fcntl(getFileDescriptor(), F_GETFL, -1);
      const int mask  = FNDELAY;
 
      if (flags == -1) {
        THROW(JSocketException, "Get socket option failed " << errno);
      }
 
      return ((flags & mask) != 0);
    }

◆ setKeepIdle()

void JNET::JTCPSocket::setKeepIdle ( const int t_s )

inline

Set the TCP idle time.

Parameters

t_s time [s]

Definition at line 98 of file JTCPSocket.hh.

    {
      setOption(IPROTO_TCP, TCP_KEEPIDLE, t_s);
    }

◆ setKeepCnt()

void JNET::JTCPSocket::setKeepCnt ( const int count )

inline

Set the TCP idle count.

Parameters

count count

Definition at line 109 of file JTCPSocket.hh.

    {
      setOption(IPROTO_TCP, TCP_KEEPCNT, count);
    }

◆ setKeepIntvl()

void JNET::JTCPSocket::setKeepIntvl ( const int t_s )

inline

Set the TCP interval time.

Parameters

t_s time [s]

Definition at line 120 of file JTCPSocket.hh.

    {
      setOption(IPROTO_TCP, TCP_KEEPINTVL, t_s);
    }

◆ setTcpNoDelay()

void JNET::JTCPSocket::setTcpNoDelay ( const bool on )

inline

Set TCP no-delay.

Parameters

on	true to set TCP no-delay; false to disable

Definition at line 131 of file JTCPSocket.hh.

    {
      setOption(IPPROTO_TCP, TCP_NODELAY, int(on ? 1 : 0));
    }

◆ getTcpNoDelay()

bool JNET::JTCPSocket::getTcpNoDelay ( ) const

inline

Get TCP no-delay.

Returns: true if TCP no-delay; else false

Definition at line 142 of file JTCPSocket.hh.

    {
      return (getOption<int>(IPPROTO_TCP, TCP_NODELAY) == 1);
    }

◆ accept()

void JNET::JTCPSocket::accept ( const int server )

inline

Accept connection from a server.

Parameters

server file descriptor of TCP server socket

Definition at line 153 of file JTCPSocket.hh.

    {
      socklen_t size = sizeof(sockaddr_in);
 
      fileDescriptor = ::accept(server, getSockaddr(), &size);
    }

◆ connect() [1/4]

void JNET::JTCPSocket::connect ( const int port )

inline

Connect to port on local host.

Parameters

port	port number

Definition at line 166 of file JTCPSocket.hh.

    {
      connect(INADDR_ANY, port);
    }

◆ connect() [2/4]

void JNET::JTCPSocket::connect ( const JHostname & hostname )

inline

Connect to port on specified host.

Parameters

hostname host name

Definition at line 177 of file JTCPSocket.hh.

    {
      connect(hostname.hostname, hostname.port);
    }

◆ connect() [3/4]

void JNET::JTCPSocket::connect	(	const std::string &	hostname,
		const int	port )

inline

Connect to port on specified host.

Parameters

hostname	host name
port	port number

Definition at line 189 of file JTCPSocket.hh.

    {
      connect(JSYSTEM::getIPnumber(hostname), port);
    }

◆ connect() [4/4]

void JNET::JTCPSocket::connect	(	const int	ip_number,
		const int	port )

inline

Connect to port on specified host.

Parameters

ip_number	IP number
port	port number

Definition at line 201 of file JTCPSocket.hh.

    {
      setIPnumber(ip_number);
      setPort(port);
 
      if (::connect(getFileDescriptor(), getSockaddr(), sizeof(sockaddr_in)) < 0) {
        THROW(JSocketException, "Socket connection failed " << JSYSTEM::getIPaddress(ip_number) << ":" << port << " / " << getFileDescriptor() << " " << errno);
      }
    }

◆ getDefaultBufferSize()

static const int JNET::JSocket::getDefaultBufferSize ( )

inlinestaticinherited

Default socket buffer size to be used on this system.

Returns: number of bytes

Definition at line 75 of file JSocket.hh.

    {
#if __APPLE__
         return JMATH::MEGABYTE;
#else
         return JMATH::GIGABYTE;
#endif
    }

◆ shutdown()

int JNET::JSocket::shutdown ( )

inlineinherited

Shut down socket.

Returns: return value

Definition at line 89 of file JSocket.hh.

    {
      const int value = ::shutdown(getFileDescriptor(), SHUT_RDWR);
 
      close();
 
      return value;
    }

◆ setKeepAlive()

void JNET::JSocket::setKeepAlive ( const bool on )

inlineinherited

Set keep alive of socket.

Parameters

on	true to enable keep alive; false to disable

Definition at line 104 of file JSocket.hh.

    {
      setOption(SOL_SOCKET, SO_KEEPALIVE, int(on ? 1 : 0));
    }

◆ getKeepAlive()

bool JNET::JSocket::getKeepAlive ( ) const

inlineinherited

Get keep alive of socket.

Returns: true if keep alive; else false

Definition at line 115 of file JSocket.hh.

    {
      return (getOption<int>(SOL_SOCKET, SO_KEEPALIVE) == 1);
    }

◆ setReuseAddress()

void JNET::JSocket::setReuseAddress ( const bool on )

inlineinherited

Set reuse address.

Parameters

on	true to enable reuse address; false to disable

Definition at line 126 of file JSocket.hh.

    {
      setOption(SOL_SOCKET, SO_REUSEADDR, int(on ? 1 : 0));
    }

◆ getReuseAddress()

bool JNET::JSocket::getReuseAddress ( ) const

inlineinherited

Get reuse address.

Returns: true if enable reuse address; else false

Definition at line 137 of file JSocket.hh.

    {
      return (getOption<int>(SOL_SOCKET, SO_REUSEADDR) == 1);
    }

◆ setReceiveBufferSize()

void JNET::JSocket::setReceiveBufferSize ( const int size )

inlineinherited

Set receive buffer size.

Parameters

size	number of bytes

Definition at line 148 of file JSocket.hh.

    {
      setOption(SOL_SOCKET, SO_RCVBUF, int(size));
    }

◆ getReceiveBufferSize()

int JNET::JSocket::getReceiveBufferSize ( ) const

inlineinherited

Set receive buffer size.

Returns: number of bytes

Definition at line 159 of file JSocket.hh.

    {
      return getOption<int>(SOL_SOCKET, SO_RCVBUF);
    }

◆ setSendBufferSize()

void JNET::JSocket::setSendBufferSize ( const int size )

inlineinherited

Set send buffer size.

Parameters

size	number of bytes

Definition at line 170 of file JSocket.hh.

    {
      setOption(SOL_SOCKET, SO_SNDBUF, int(size));
    }

◆ getSendBufferSize()

int JNET::JSocket::getSendBufferSize ( ) const

inlineinherited

Get send buffer size.

Returns: number of bytes

Definition at line 181 of file JSocket.hh.

    {
      return getOption<int>(SOL_SOCKET, SO_SNDBUF);
    }

◆ read()

virtual int JNET::JSocket::read	(	char *	buffer,
		const int	length )

inlineoverridevirtualinherited

Read data from socket.

This method handles I/O errors in such a way that:

the return value is set to zero if no data are read;
an exception is thrown in case of a fatal error;

Parameters

buffer	buffer
length	number of bytes to read

Returns: number of bytes actually read

Reimplemented from JLANG::JFile.

Reimplemented in JNET::JSocketBlocking, JNET::JSocketInputChannel< JPrefix_t >, JNET::JSocketNonblockingReader, and JNET::JUDPSocket.

Definition at line 198 of file JSocket.hh.

    {
      int pos = JFile::read(buffer, length);
 
      if        (pos == 0) {
        
        THROW(JSocketException, "Socket read failed " << getFileDescriptor() << ' ' << errno);
        
      } else if (pos <  0) {
        
        switch (errno) {
          
        case EINTR:
        case EWOULDBLOCK:
          //case EAGAIN:
          break;
          
        default:
          THROW(JSocketException, "Socket read error " << getFileDescriptor() << ' ' << errno);
        }
 
        pos = 0;
      }
 
      return pos;
    }

◆ write()

virtual int JNET::JSocket::write	(	const char *	buffer,
		const int	length )

inlineoverridevirtualinherited

Write data to socket.

This method handles I/O errors in such a way that:

the return value is set to zero if no data are written;
an exception is thrown in case of a fatal error;

Parameters

buffer	buffer
length	number of bytes to write

Returns: number of bytes actually written

Reimplemented from JLANG::JFile.

Reimplemented in JNET::JSocketBlocking, JNET::JSocketNonblockingWriter, JNET::JSocketOutputChannel< JPrefix_t >, and JNET::JUDPSocket.

Definition at line 237 of file JSocket.hh.

    {
      int pos = JFile::write(buffer, length);
 
      if        (pos == 0) {
        
        THROW(JSocketException, "Socket write failed " << getFileDescriptor() << ' ' << errno);
        
      } else if (pos <  0) {
        
        switch (errno) {
          
        case EINTR:
        case EWOULDBLOCK:
          //case EAGAIN:
          break;
          
        default:
          THROW(JSocketException, "Socket write error " << getFileDescriptor() << ' ' << errno);
        }
 
        pos = 0;
      }
 
      return pos;
    }

◆ setOption()

template<class T >

void JNET::JSocket::setOption	(	const int	level,
		const int	option,
		const T	value )

inlineprotectedinherited

Set socket option.

Parameters

level	level
option	option
value	value

Definition at line 274 of file JSocket.hh.

    {
      socklen_t size = sizeof(T);
 
      if (setsockopt(getFileDescriptor(), level, option, &value, size) < 0) {
        THROW(JSocketException, "Set socket option failed " << errno);
      }
    }

◆ getOption()

template<class T >

T JNET::JSocket::getOption	(	const int	level,
		const int	option ) const

inlineprotectedinherited

Get socket option.

Parameters

level	level
option	option

Returns: value

Definition at line 292 of file JSocket.hh.

    {
      T         value;
      socklen_t size  = sizeof(T);
 
      if (getsockopt(getFileDescriptor(), level, option, &value, &size) < 0) {
        THROW(JSocketException, "Get socket option failed " << errno);
      }
 
      return value;
    }

◆ close()

int JLANG::JFile::close ( )

inlineinherited

Close file.

Returns: return value

Definition at line 57 of file JFile.hh.

    {
      int value = -1;
 
      if (fileDescriptor != FILE_CLOSED) {
 
        value = ::close(fileDescriptor);
 
        fileDescriptor = FILE_CLOSED;
        result         = 0;
      }
 
      return value;
    }

◆ in_avail()

bool JLANG::JFile::in_avail ( JTimeval timeout = JTimeval::min() ) const

inlineinherited

Check availability of input.

This method returns true if at least one byte can be read without blocking.

Parameters

timeout timeout

Returns: true if ready to read; else false

Definition at line 106 of file JFile.hh.

    {
      return JFileDescriptorMask(*this).in_avail(timeout);
    }

◆ out_avail()

bool JLANG::JFile::out_avail ( JTimeval timeout = JTimeval::min() ) const

inlineinherited

Check availability of output.

This method returns true if at least one byte can be written without blocking.

Parameters

timeout timeout

Returns: true if ready to write; else false

Definition at line 119 of file JFile.hh.

    {
      return JFileDescriptorMask(*this).out_avail(timeout);
    }

◆ good()

virtual bool JLANG::JFile::good ( ) const

inlinevirtualinherited

Check status.

Returns: true if last I/O operation successful; else false

Definition at line 130 of file JFile.hh.

    {
      return is_open() && !eof() && !bad();
    }

◆ fail()

virtual bool JLANG::JFile::fail ( ) const

inlinevirtualinherited

Check status.

Returns: true if last I/O operation caused logical error; else false

Definition at line 141 of file JFile.hh.

    {
      return result == 0;
    }

◆ bad()

virtual bool JLANG::JFile::bad ( ) const

inlinevirtualinherited

Check status.

Returns: true if last I/O operation caused read/write error; else false

Definition at line 152 of file JFile.hh.

    {
      return fail();
    }

◆ eof()

virtual bool JLANG::JFile::eof ( ) const

inlinevirtualinherited

Check end of file.

Returns: true if end of file; else false

Definition at line 163 of file JFile.hh.

    {
      return result == EOF;
    }

◆ less()

bool JLANG::JAbstractFile::less ( const JAbstractFile & file ) const

inlineinherited

Less than operation.

Parameters

file	JAbstractFile to be compared

Returns: true if this file descriptor is less; else false

Definition at line 64 of file JAbstractFile.hh.

    {
      return getFileDescriptor() < file.getFileDescriptor();
    }

◆ getFileDescriptor()

int JLANG::JAbstractFile::getFileDescriptor ( ) const

inlineinherited

Get file descriptor.

Returns: file descriptor

Definition at line 75 of file JAbstractFile.hh.

    {
      return fileDescriptor;
    }

◆ setFileDescriptor()

void JLANG::JAbstractFile::setFileDescriptor ( const int file )

inlineinherited

Set file descriptor.

Parameters

file	file descriptor

Definition at line 86 of file JAbstractFile.hh.

    {
      fileDescriptor = file;
    }

◆ is_open()

bool JLANG::JAbstractFile::is_open ( ) const

inlineinherited

Get open status.

Definition at line 95 of file JAbstractFile.hh.

    {
      return fileDescriptor != FILE_CLOSED;
    }

◆ getSockaddr() [1/2]

const sockaddr * JNET::JSocketAddress::getSockaddr ( ) const

inlineinherited

Get sockaddr.

Returns: pointer to sockaddr structure

Definition at line 44 of file JSocketAddress.hh.

    {
      return (const sockaddr*) static_cast<const sockaddr_in*>(this);
    }

◆ getSockaddr() [2/2]

sockaddr * JNET::JSocketAddress::getSockaddr ( )

inlineinherited

Get sockaddr.

Returns: pointer to sockaddr structure

Definition at line 55 of file JSocketAddress.hh.

    {
      return (sockaddr*) static_cast<sockaddr_in*>(this);
    }

◆ getFamily()

int JNET::JSocketAddress::getFamily ( ) const

inlineinherited

Get family.

Returns: family

Definition at line 66 of file JSocketAddress.hh.

    {
      return sin_family;
    }

◆ setFamily()

void JNET::JSocketAddress::setFamily ( const int family )

inlineinherited

Set family.

Parameters

family family

Definition at line 77 of file JSocketAddress.hh.

    {
      sin_family = family;
    }

◆ getHostname()

std::string JNET::JSocketAddress::getHostname ( ) const

inlineinherited

Get host name.

Returns: host name

Definition at line 88 of file JSocketAddress.hh.

    {
      return JSYSTEM::getHostname(this->getIPnumber());
    }

◆ getIPnumber()

int JNET::JSocketAddress::getIPnumber ( ) const

inlineinherited

Get IP number.

Returns: IP number

Definition at line 99 of file JSocketAddress.hh.

    {
      return sin_addr.s_addr;
    }

◆ setIPnumber() [1/2]

void JNET::JSocketAddress::setIPnumber ( const int ip_number )

inlineinherited

Set IP number.

Parameters

ip_number IP number

Definition at line 110 of file JSocketAddress.hh.

    {
      sin_addr.s_addr = ip_number;
    }

◆ setIPnumber() [2/2]

void JNET::JSocketAddress::setIPnumber ( )

inlineinherited

Set any IP number.

Definition at line 119 of file JSocketAddress.hh.

    {
      sin_addr.s_addr = htonl(INADDR_ANY);
    }

◆ getPort()

int JNET::JSocketAddress::getPort ( ) const

inlineinherited

Get port number.

Returns: port number

Definition at line 130 of file JSocketAddress.hh.

    {
      return ntohs(this->sin_port);
    }

◆ setPort()

void JNET::JSocketAddress::setPort ( const int port )

inlineinherited

Set port number.

Parameters

port	port number

Definition at line 141 of file JSocketAddress.hh.

    {
      if (port >= 0 && port <= std::numeric_limits<u_short>::max())
        sin_port = htons((u_short) port);
      else
        THROW(JCastException, "JSocketAddress::setPort() illegal value.");
    }

◆ sizeOf()

static int JNET::JSocketAddress::sizeOf ( )

inlinestaticinherited

Get size of object.

Returns: number of bytes

Definition at line 155 of file JSocketAddress.hh.

    {
      return sizeof(sockaddr_in);
    }

Member Data Documentation

◆ result

int JLANG::JFile::result

privateinherited

Definition at line 170 of file JFile.hh.

◆ FILE_CLOSED

const int JLANG::JAbstractFile::FILE_CLOSED = -1

staticinherited

Definition at line 27 of file JAbstractFile.hh.

◆ fileDescriptor

int JLANG::JAbstractFile::fileDescriptor

protectedinherited

Definition at line 102 of file JAbstractFile.hh.

The documentation for this class was generated from the following file:

JTCPSocket.hh

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JTCPSocket() [1/2]

◆ JTCPSocket() [2/2]

Member Function Documentation

◆ setNonBlocking()

◆ getNonBlocking()

◆ setKeepIdle()

◆ setKeepCnt()

◆ setKeepIntvl()

◆ setTcpNoDelay()

◆ getTcpNoDelay()

◆ accept()

◆ connect() [1/4]

◆ connect() [2/4]

◆ connect() [3/4]

◆ connect() [4/4]

◆ getDefaultBufferSize()

◆ shutdown()

◆ setKeepAlive()

◆ getKeepAlive()

◆ setReuseAddress()

◆ getReuseAddress()

◆ setReceiveBufferSize()

◆ getReceiveBufferSize()

◆ setSendBufferSize()

◆ getSendBufferSize()

◆ read()

◆ write()

◆ setOption()

◆ getOption()

◆ close()

◆ in_avail()

◆ out_avail()

◆ good()

◆ fail()

◆ bad()

◆ eof()

◆ less()

◆ getFileDescriptor()

◆ setFileDescriptor()

◆ is_open()

◆ getSockaddr() [1/2]

◆ getSockaddr() [2/2]

◆ getFamily()

◆ setFamily()

◆ getHostname()

◆ getIPnumber()

◆ setIPnumber() [1/2]

◆ setIPnumber() [2/2]

◆ getPort()

◆ setPort()

◆ sizeOf()

Member Data Documentation

◆ result

◆ FILE_CLOSED

◆ fileDescriptor