JNET::JSocketNonblockingReader Class Reference

Non-blocking socket reader. More...

#include <JSocketNonblocking.hh>

Inheritance diagram for JNET::JSocketNonblockingReader:

Public Types
enum	JStatus_t { IO_RESET = -1, IO_READY = 0, IO_BUSY = +1 }

Public Member Functions
	JSocketNonblockingReader (const JSocket &socket)
	Constructor. More...
JStatus_t	read ()
	Continuation of non-blocking read method. More...
int	shutdown ()
	Shut down socket. More...
void	setNonBlocking (const bool on)
	Set non-blocking of I/O. More...
bool	getNonBlocking () const
	Get non-blocking of I/O. More...
void	setKeepAlive (const bool on)
	Set keep alive of socket. More...
bool	getKeepAlive () const
	Get keep alive of socket. More...
void	setKeepIdle (const int t_s)
	Set the TCP idle time. More...
void	setKeepCnt (const int count)
	Set the TCP idle count. More...
void	setKeepIntvl (const int t_s)
	Set the TCP interval time. More...
void	setReuseAddress (const bool on)
	Set reuse address. More...
bool	getReuseAddress () const
	Get reuse address. More...
void	setTcpNoDelay (const bool on)
	Set TCP no-delay. More...
bool	getTcpNoDelay () const
	Get TCP no-delay. More...
void	setReceiveBufferSize (const int size)
	Set receive buffer size. More...
int	getReceiveBufferSize () const
	Set receive buffer size. More...
void	setSendBufferSize (const int size)
	Set send buffer size. More...
int	getSendBufferSize () const
	Get send buffer size. More...
virtual int	read (char *buffer, const int length) override
	Read data from socket. More...
virtual int	write (const char *buffer, const int length) override
	Write data to socket. More...
void	accept (const int server)
	Accept connection from a server. More...
void	connect (const int port)
	Connect to port on local host. More...
void	connect (const std::string &host_name, const int port)
	Connect to port on specified host. More...
void	connect (const int ip_number, const int port)
	Connect to port on specified host. More...
void	close ()
	Close file. More...
bool	in_avail (JTimeval timeout=JTimeval::min()) const
	Check availability of input. More...
bool	out_avail (JTimeval timeout=JTimeval::min()) const
	Check availability of output. More...
virtual bool	good () const
	Check status. More...
virtual bool	fail () const
	Check status. More...
virtual bool	bad () const
	Check status. More...
virtual bool	eof () const
	Check end of file. More...
bool	less (const JAbstractFile &file) const
	Less than operation. More...
int	getFileDescriptor () const
	Get file descriptor. More...
bool	is_open () const
	Get open status. More...
const sockaddr *	getSockaddr () const
	Get sockaddr. More...
sockaddr *	getSockaddr ()
	Get sockaddr. More...
int	getFamily () const
	Get family. More...
void	setFamily (const int family)
	Set family. More...
std::string	getHostname () const
	Get host name. More...
int	getIPnumber () const
	Get IP number. More...
void	setIPnumber (const int ip_number)
	Set IP number. More...
void	setIPnumber ()
	Set any IP number. More...
int	getPort () const
	Get port number. More...
void	setPort (const int port)
	Set port number. More...
int	getSize () const
	Get size of pending data. More...
void	set (const JSocketBuffer< JElement_t > &buffer)
	Initialise buffer. More...
void	set (JElement_t *buffer, const int length)
	Initialise buffer. More...
void	reset ()
	Reset. More...
JStatus_t	getStatus () const
	Get status of I/O. More...
bool	isReset () const
	Check reset status. More...
bool	isBusy () const
	Check busy status. More...
bool	isReady () const
	Check ready status. More...
int	getCounter () const
	Get number of I/O attempts. More...

Static Public Member Functions
static int	sizeOf ()
	Get size of object. More...

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. More...
template<class T >
T	getOption (const int level, const int option) const
	Get socket option. More...
void	setStatus (const JStatus_t status)
	Set status of I/O. More...

Protected Attributes
int	fileDescriptor
JElement_t *	__data
int	__size
JStatus_t	status
int	counter

Detailed Description

Non-blocking socket reader.

This class can be used in case of non-blocking I/O (see method JSocket::setNonBlocking()).

Definition at line 118 of file JSocketNonblocking.hh.

Member Enumeration Documentation

enum JNET::JSocketStatus::JStatus_t

inherited

Enumerator
IO_RESET
IO_READY
IO_BUSY

Definition at line 26 of file JSocketStatus.hh.

{ IO_RESET = -1, IO_READY = 0, IO_BUSY = +1 };

Constructor & Destructor Documentation

JNET::JSocketNonblockingReader::JSocketNonblockingReader ( const JSocket &  socket )

inline

Constructor.

Parameters

socket

socket

Definition at line 128 of file JSocketNonblocking.hh.

                                                    :
      JSocket(socket),
      JSocketInputBuffer()
    {}

Member Function Documentation

JStatus_t JNET::JSocketNonblockingReader::read ( )

inline

Continuation of non-blocking read method.

Returns

status

Definition at line 139 of file JSocketNonblocking.hh.

    {
      if (status == IO_BUSY) {

        ++counter;
        
        const int pos = JSocket::read(__data, __size);
        
        __data += pos;
        __size -= pos;

      } else {

        THROW(JSocketException, "Calling socket non-blocking read() while not busy.");
      }

      if (__size == 0) {
        status = IO_READY;
      }

      return status;
    }

int JNET::JSocket::shutdown ( )

inlineinherited

Shut down socket.

Definition at line 95 of file JSocket.hh.

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

      close();

      return value;
    }

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

inlineinherited

Set non-blocking of I/O.

Parameters

on	true to enable non-blocking; false to disable

Definition at line 110 of file JSocket.hh.

    {
      const int flags = fcntl(getFileDescriptor(), F_GETFL, -1);
      const int mask  = FNDELAY;

      if (flags == -1) {
        THROW(JSocketException, "Get socket option failed.");
      }

      if (((flags & mask) != mask &&  on) ||
          ((flags & mask) != 0    && !on) ) {

        if (fcntl(getFileDescriptor(), F_SETFL, flags ^ mask) < 0) {
          THROW(JSocketException, "Set socket option failed.");   
        }
      }
    }

bool JNET::JSocket::getNonBlocking ( ) const

inlineinherited

Get non-blocking of I/O.

Returns

true if enabled non-blocking; else false

Definition at line 134 of file JSocket.hh.

    {
      const int flags = fcntl(getFileDescriptor(), F_GETFL, -1);
      const int mask  = FNDELAY;

      if (flags == -1) {
        THROW(JSocketException, "Get socket option failed.");
      }

      return ((flags & mask) != 0);
    }

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 152 of file JSocket.hh.

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

bool JNET::JSocket::getKeepAlive ( ) const

inlineinherited

Get keep alive of socket.

Returns

true if keep alive; else false

Definition at line 163 of file JSocket.hh.

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

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

inlineinherited

Set the TCP idle time.

Parameters

t_s

time [s]

Definition at line 174 of file JSocket.hh.

    {
      setOption(IPROTO_TCP, TCP_KEEPIDLE, t_s);
    }

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

inlineinherited

Set the TCP idle count.

Parameters

count

count

Definition at line 185 of file JSocket.hh.

    {
      setOption(IPROTO_TCP, TCP_KEEPCNT, count);
    }

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

inlineinherited

Set the TCP interval time.

Parameters

t_s

time [s]

Definition at line 196 of file JSocket.hh.

    {
      setOption(IPROTO_TCP, TCP_KEEPINTVL, t_s);
    }

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

inlineinherited

Set reuse address.

Parameters

on	true to enable reuse address; false to disable

Definition at line 207 of file JSocket.hh.

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

bool JNET::JSocket::getReuseAddress ( ) const

inlineinherited

Get reuse address.

Returns

true if enable reuse address; else false

Definition at line 218 of file JSocket.hh.

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

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

inlineinherited

Set TCP no-delay.

Parameters

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

Definition at line 229 of file JSocket.hh.

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

bool JNET::JSocket::getTcpNoDelay ( ) const

inlineinherited

Get TCP no-delay.

Returns

true if TCP no-delay; else false

Definition at line 240 of file JSocket.hh.

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

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

inlineinherited

Set receive buffer size.

Parameters

size	number of bytes

Definition at line 251 of file JSocket.hh.

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

int JNET::JSocket::getReceiveBufferSize ( ) const

inlineinherited

Set receive buffer size.

Returns

number of bytes

Definition at line 262 of file JSocket.hh.

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

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

inlineinherited

Set send buffer size.

Parameters

size	number of bytes

Definition at line 273 of file JSocket.hh.

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

int JNET::JSocket::getSendBufferSize ( ) const

inlineinherited

Get send buffer size.

Returns

number of bytes

Definition at line 284 of file JSocket.hh.

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

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:

1. the return value is set to zero if no data are read;
2. 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.

Definition at line 301 of file JSocket.hh.

    {
      int pos = JFile::read(buffer, length);

      if        (pos == 0) {
        
        THROW(JSocketException, "Socket read failed.");
        
      } else if (pos <  0) {
        
        switch (errno) {
          
        case EINTR:
        case EWOULDBLOCK:
          //case EAGAIN:
          break;
          
        default:
          THROW(JSocketException, "Socket read error.");
        }

        pos = 0;
      }

      return pos;
    }

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:

1. the return value is set to zero if no data are written;
2. 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.

Definition at line 340 of file JSocket.hh.

    {
      int pos = JFile::write(buffer, length);

      if        (pos == 0) {
        
        THROW(JSocketException, "Socket write failed.");
        
      } else if (pos <  0) {
        
        switch (errno) {
          
        case EINTR:
        case EWOULDBLOCK:
          //case EAGAIN:
          break;
          
        default:
          THROW(JSocketException, "Socket write error.");
        }

        pos = 0;
      }

      return pos;
    }

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

inlineinherited

Accept connection from a server.

Parameters

server

file descriptor of server socket

Definition at line 373 of file JSocket.hh.

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

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

inlineinherited

Connect to port on local host.

Parameters

port	port number

Definition at line 385 of file JSocket.hh.

    {
      connect(INADDR_ANY, port);
    }

void JNET::JSocket::connect ( const std::string &  host_name, const int  port  )

inlineinherited

Connect to port on specified host.

Parameters

host_name	host name
port	port number

Definition at line 397 of file JSocket.hh.

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

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

inlineinherited

Connect to port on specified host.

Parameters

ip_number	IP number
port	port number

Definition at line 409 of file JSocket.hh.

    {
      setIPnumber(ip_number);
      setPort(port);

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

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 429 of file JSocket.hh.

    {
      socklen_t size = sizeof(T);

      if (setsockopt(getFileDescriptor(), level, option, &value, size) < 0) {
        THROW(JSocketException, "Set socket option failed.");
      }
    }

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 447 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.");
      }

      return value;
    }

void JLANG::JFile::close ( )

inlineinherited

Close file.

Definition at line 55 of file JFile.hh.

    {
      if (fileDescriptor != FILE_CLOSED) {

        ::close(fileDescriptor);

        fileDescriptor = FILE_CLOSED;
        result         = 0;
      }
    }

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 100 of file JFile.hh.

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

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 113 of file JFile.hh.

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

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

inlinevirtualinherited

Check status.

Returns

true if last I/O operation successful; else false

Definition at line 124 of file JFile.hh.

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

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

inlinevirtualinherited

Check status.

Returns

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

Definition at line 135 of file JFile.hh.

    {
      return result == 0;
    }

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 146 of file JFile.hh.

    {
      return fail();
    }

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

inlinevirtualinherited

Check end of file.

Returns

true if end of file; else false

Definition at line 157 of file JFile.hh.

    {
      return result == EOF;
    }

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();
    }

int JLANG::JAbstractFile::getFileDescriptor ( ) const

inlineinherited

Get file descriptor.

Returns

file descriptor

Definition at line 75 of file JAbstractFile.hh.

    {
      return fileDescriptor;
    }

bool JLANG::JAbstractFile::is_open ( ) const

inlineinherited

Get open status.

Definition at line 84 of file JAbstractFile.hh.

    {
      return fileDescriptor != FILE_CLOSED;
    }

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);
    }

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);
    }

int JNET::JSocketAddress::getFamily ( ) const

inlineinherited

Get family.

Returns

family

Definition at line 66 of file JSocketAddress.hh.

    {
      return sin_family;
    }

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

inlineinherited

Set family.

Parameters

family

family

Definition at line 77 of file JSocketAddress.hh.

    {
      sin_family = family;
    }

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());
    }

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;
    }

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;
    }

void JNET::JSocketAddress::setIPnumber ( )

inlineinherited

Set any IP number.

Definition at line 119 of file JSocketAddress.hh.

    {
      sin_addr.s_addr = htonl(INADDR_ANY);
    }

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);
    }

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.");
    }

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);
    }

template<class JElement_t>

int JNET::JSocketBuffer< JElement_t >::getSize ( ) const

inlineinherited

Get size of pending data.

Returns

number of bytes

Definition at line 55 of file JSocketNonblocking.hh.

    {
      return __size;
    }

template<class JElement_t>

void JNET::JSocketBuffer< JElement_t >::set ( const JSocketBuffer< JElement_t > &  buffer )

inlineinherited

Initialise buffer.

Parameters

buffer

buffer

Definition at line 66 of file JSocketNonblocking.hh.

    {
      set(buffer.__data, buffer.__size);
    }

template<class JElement_t>

void JNET::JSocketBuffer< JElement_t >::set ( JElement_t *  buffer, const int  length  )

inlineinherited

Initialise buffer.

Parameters

buffer	I/O data
length	number of bytes

Definition at line 78 of file JSocketNonblocking.hh.

    {
      if (status == IO_BUSY) {
        THROW(JSocketException, "Set socket buffer I/O while busy.");
      }

      status  = (length != 0 ? IO_BUSY : IO_READY);
      counter = 0;
      __data  = buffer;
      __size  = length;
    }

template<class JElement_t>

void JNET::JSocketBuffer< JElement_t >::reset ( )

inlineinherited

Reset.

Definition at line 94 of file JSocketNonblocking.hh.

    {
      JSocketStatus::reset();

      __data  = NULL;
      __size  = 0;
    }

JStatus_t JNET::JSocketStatus::getStatus ( ) const

inlineinherited

Get status of I/O.

Returns

status

Definition at line 43 of file JSocketStatus.hh.

    {
      return status;
    }

bool JNET::JSocketStatus::isReset ( ) const

inlineinherited

Check reset status.

Returns

true if reset; else false

Definition at line 54 of file JSocketStatus.hh.

    {
      return status == IO_RESET;
    }

bool JNET::JSocketStatus::isBusy ( ) const

inlineinherited

Check busy status.

Returns

true if busy; else false

Definition at line 65 of file JSocketStatus.hh.

    {
      return status == IO_BUSY;
    }

bool JNET::JSocketStatus::isReady ( ) const

inlineinherited

Check ready status.

Returns

true if ready; else false

Definition at line 76 of file JSocketStatus.hh.

    {
      return status == IO_READY;
    }

int JNET::JSocketStatus::getCounter ( ) const

inlineinherited

Get number of I/O attempts.

Returns

number of I/O attempts

Definition at line 87 of file JSocketStatus.hh.

    {
      return counter;
    }

void JNET::JSocketStatus::setStatus ( const JStatus_t  status )

inlineprotectedinherited

Set status of I/O.

Parameters

status

status

Definition at line 109 of file JSocketStatus.hh.

    {
      this->status = status;
    }

Member Data Documentation

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

staticinherited

Definition at line 27 of file JAbstractFile.hh.

int JLANG::JAbstractFile::fileDescriptor

protectedinherited

Definition at line 91 of file JAbstractFile.hh.

template<class JElement_t>

JElement_t* JNET::JSocketBuffer< JElement_t >::__data

protectedinherited

Definition at line 104 of file JSocketNonblocking.hh.

template<class JElement_t>

int JNET::JSocketBuffer< JElement_t >::__size

protectedinherited

Definition at line 105 of file JSocketNonblocking.hh.

JStatus_t JNET::JSocketStatus::status

protectedinherited

Definition at line 115 of file JSocketStatus.hh.

int JNET::JSocketStatus::counter

protectedinherited

Definition at line 116 of file JSocketStatus.hh.

---

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

• JSocketNonblocking.hh