JNET::JSocketInputChannel< JPrefix_t > Class Template Reference

Socket input channel. More...

#include <JSocketChannel.hh>

Inheritance diagram for JNET::JSocketInputChannel< JPrefix_t >:

Public Types
enum	JStatus_t { IO_RESET = -1 , IO_READY = 0 , IO_BUSY = +1 }
enum	JType { IO_PREFIX = 1 , IO_DATA = 2 }

Public Member Functions
	JSocketInputChannel (JTCPSocket &socket)
	Constructor. More...
JStatus_t	read ()
	Interruptable read method. More...
void	reset ()
	Reset channel. More...
virtual int	read (char *buffer, const int length) override
	Read byte array. More...
virtual int	read (char *buffer, const int length) override
	Read data from 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	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	setTcpNoDelay (const bool on)
	Set TCP no-delay. More...
bool	getTcpNoDelay () const
	Get TCP no-delay. 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 JHostname &hostname)
	Connect to port on specified host. More...
void	connect (const std::string &hostname, 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...
int	shutdown ()
	Shut down socket. More...
void	setKeepAlive (const bool on)
	Set keep alive of socket. More...
bool	getKeepAlive () const
	Get keep alive of socket. More...
void	setReuseAddress (const bool on)
	Set reuse address. More...
bool	getReuseAddress () const
	Get reuse address. 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	write (const char *buffer, const int length) override
	Write data to socket. More...
int	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...
void	setFileDescriptor (const int file)
	Set 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...
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...
int	size () const
	Get size. More...
const char *	data () const
	Get data. More...
int	getRemainingSize () const
	Get remaining size. More...
const char *	getRemainingData () const
	Get remaining data. More...
int	tellg () const
	Get read position. More...
void	seekg (const int pos)
	Set read position. More...
virtual bool	getStatus () const override
	Status of reader. More...
virtual int	read (char *buffer, const int length) override
	Read byte array. More...
virtual void	clear ()
	Clear status of reader. More...
JReader &	operator>> (JSerialisable &object)
	Read serialisable data object. More...
JReader &	operator>> (bool &value)
JReader &	operator>> (char &value)
JReader &	operator>> (unsigned char &value)
JReader &	operator>> (short &value)
JReader &	operator>> (unsigned short &value)
JReader &	operator>> (int &value)
JReader &	operator>> (unsigned int &value)
JReader &	operator>> (long int &value)
JReader &	operator>> (unsigned long int &value)
JReader &	operator>> (long long int &value)
JReader &	operator>> (unsigned long long int &value)
JReader &	operator>> (float &value)
JReader &	operator>> (double &value)
JReader &	operator>> (long double &value)
JReader &	operator>> (JLANG::JObjectID &value)
JReader &	load (JSerialisable &object)
	Read object. More...
template<class T >
JReader &	load (T &object)
	Read object. More...
	operator bool () const
	Type conversion operator. More...
bool	operator! () const
	Negated status of this object. More...

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

Public Attributes
JPrefix_t	prefix

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
JType	type
const char *	__data
int	__size
int	__pos

Private Attributes
std::vector< char >	buffer
int	result

Detailed Description

template<class JPrefix_t>
class JNET::JSocketInputChannel< JPrefix_t >

Socket input channel.

This class can be used to read a data packet from a socket without blocking and to buffer these data for subsequent user read operations.

The template argument corresponds to a header that precedes any data. This header acts as a protocol specifier that is used to determine the size of the data packet. To this end, the method getSizeOfPacket() should be implemented for each header type.

The reading from the socket may be non-blocking (depending on the configuration of the socket). The status of this object should be checked for completion of the data packet. The method reset() should be called before reading the next data packet.

Definition at line 86 of file JSocketChannel.hh.

Member Enumeration Documentation

JStatus_t

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

JType

enum JNET::JSocketChannel::JType

inherited

Enumerator
IO_PREFIX
IO_DATA

Definition at line 54 of file JSocketChannel.hh.

{ IO_PREFIX = 1, IO_DATA = 2 };

Constructor & Destructor Documentation

JSocketInputChannel()

template<class JPrefix_t >

JNET::JSocketInputChannel< JPrefix_t >::JSocketInputChannel ( JTCPSocket &  socket )

inline

Constructor.

Parameters

socket

socket

Definition at line 102 of file JSocketChannel.hh.

                                            :
      JSocketNonblockingReader(socket),
      JSocketChannel(),
      JByteArrayReader()
    {
      reset();
    }

Member Function Documentation

read() [1/4]

template<class JPrefix_t >

JStatus_t JNET::JSocketInputChannel< JPrefix_t >::read ( )

inline

Interruptable read method.

Returns

status

Definition at line 116 of file JSocketChannel.hh.

    {
      if (type == IO_PREFIX) {
 
        if (isReset()) {
          set((char*) &prefix, sizeof(JPrefix_t));
        }
 
        if (isBusy()) {
          JSocketNonblockingReader::read();
        }
 
        if (isReady()) {
 
          buffer.clear();
 
          buffer.resize(getSizeOfPacket(prefix));
 
          memcpy(buffer.data(), &prefix, sizeof(JPrefix_t));
 
          set(buffer.data() + sizeof(JPrefix_t), 
              buffer.size() - sizeof(JPrefix_t));
 
          type = IO_DATA;
        }
      }
 
      if (type == IO_DATA) {
 
        if (isBusy()) {
          JSocketNonblockingReader::read();
        }
 
        if (isReady()) {
          static_cast<JByteArrayReader&>(*this) = JByteArrayReader(buffer.data(), buffer.size());
        }
      }
 
      return JSocketStatus::getStatus();
    }

reset()

template<class JPrefix_t >

void JNET::JSocketInputChannel< JPrefix_t >::reset ( )

inline

Reset channel.

After a reset, the socket channel is ready to receive a new data packet.

Definition at line 162 of file JSocketChannel.hh.

    {
      JSocketNonblockingReader::reset();
      JSocketChannel          ::reset();
 
      buffer.clear();
    }

read() [2/4]

template<class JPrefix_t >

virtual int JIO::JByteArrayReader::read

inlineoverride

Read byte array.

Parameters

buffer	pointer to byte array
length	number of bytes

Returns

number of bytes

Definition at line 136 of file JByteArrayIO.hh.

    { 
      memcpy(buffer, __data + __pos, length);
        
      __pos += length;
 
      return length;
    }

read() [3/4]

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::JUDPSocket, and JNET::JSocketBlocking.

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

setNonBlocking()

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

inlineinherited

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

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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  )

inlineinherited

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  )

inlineinherited

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

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:

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::JUDPSocket, and JNET::JSocketBlocking.

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

getSize()

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

set() [1/2]

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

set() [2/2]

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

getStatus() [1/2]

JStatus_t JNET::JSocketStatus::getStatus ( ) const

inlineinherited

Get status of I/O.

Returns

status

Definition at line 43 of file JSocketStatus.hh.

    {
      return status;
    }

isReset()

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

isBusy()

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

isReady()

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

getCounter()

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

setStatus()

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

size()

int JIO::JByteArrayReader::size ( ) const

inlineinherited

Get size.

Returns

number of bytes

Definition at line 57 of file JByteArrayIO.hh.

    {
      return __size;
    }

data()

const char* JIO::JByteArrayReader::data ( ) const

inlineinherited

Get data.

Returns

pointer to data

Definition at line 68 of file JByteArrayIO.hh.

    {
      return __data;
    }

getRemainingSize()

int JIO::JByteArrayReader::getRemainingSize ( ) const

inlineinherited

Get remaining size.

Returns

number of bytes

Definition at line 79 of file JByteArrayIO.hh.

    {
      return __size - __pos;
    }

getRemainingData()

const char* JIO::JByteArrayReader::getRemainingData ( ) const

inlineinherited

Get remaining data.

Returns

pointer to remaining data

Definition at line 90 of file JByteArrayIO.hh.

    {
      return __data + __pos;
    }

tellg()

int JIO::JByteArrayReader::tellg ( ) const

inlineinherited

Get read position.

Returns

read position

Definition at line 101 of file JByteArrayIO.hh.

    {
      return __pos;
    }

seekg()

void JIO::JByteArrayReader::seekg ( const int  pos )

inlineinherited

Set read position.

Parameters

pos	read position

Definition at line 112 of file JByteArrayIO.hh.

    {
      __pos = pos;
    }

getStatus() [2/2]

virtual bool JIO::JByteArrayReader::getStatus ( ) const

inlineoverridevirtualinherited

Status of reader.

Returns

status of this reader

Implements JLANG::JAbstractObjectStatus.

Definition at line 123 of file JByteArrayIO.hh.

    { 
      return __size - __pos >= 0; 
    }

read() [4/4]

virtual int JIO::JByteArrayReader::read ( char *  buffer, const int  length  )

inlineoverridevirtualinherited

Read byte array.

Parameters

buffer	pointer to byte array
length	number of bytes

Returns

number of bytes

Implements JLANG::JBinaryInput.

Definition at line 136 of file JByteArrayIO.hh.

    { 
      memcpy(buffer, __data + __pos, length);
        
      __pos += length;
 
      return length;
    }

clear()

virtual void JIO::JReader::clear ( )

inlinevirtualinherited

Clear status of reader.

Reimplemented in JIO::JStreamReader, JIO::JFileStreamReader, and JIO::JBufferedReader.

Definition at line 71 of file JSerialisable.hh.

    {}

operator>>() [1/16]

JReader& JIO::JReader::operator>> ( JSerialisable &  object )

inlineinherited

Read serialisable data object.

Parameters

object

serialisable data object

Returns

JReader

Definition at line 81 of file JSerialisable.hh.

    { 
      return object.read(*this); 
    }

operator>>() [2/16]

JReader& JIO::JReader::operator>> ( bool &  value )

inlineinherited

Definition at line 87 of file JSerialisable.hh.

{ read((char*) &value, sizeof(bool));                   return *this; }

operator>>() [3/16]

JReader& JIO::JReader::operator>> ( char &  value )

inlineinherited

Definition at line 88 of file JSerialisable.hh.

{ read((char*) &value, sizeof(char));                   return *this; }

operator>>() [4/16]

JReader& JIO::JReader::operator>> ( unsigned char &  value )

inlineinherited

Definition at line 89 of file JSerialisable.hh.

{ read((char*) &value, sizeof(unsigned char));          return *this; }

operator>>() [5/16]

JReader& JIO::JReader::operator>> ( short &  value )

inlineinherited

Definition at line 90 of file JSerialisable.hh.

{ read((char*) &value, sizeof(short));                  return *this; }

operator>>() [6/16]

JReader& JIO::JReader::operator>> ( unsigned short &  value )

inlineinherited

Definition at line 91 of file JSerialisable.hh.

{ read((char*) &value, sizeof(unsigned short));         return *this; }

operator>>() [7/16]

JReader& JIO::JReader::operator>> ( int &  value )

inlineinherited

Definition at line 92 of file JSerialisable.hh.

{ read((char*) &value, sizeof(int));                    return *this; }

operator>>() [8/16]

JReader& JIO::JReader::operator>> ( unsigned int &  value )

inlineinherited

Definition at line 93 of file JSerialisable.hh.

{ read((char*) &value, sizeof(unsigned int));           return *this; }

operator>>() [9/16]

JReader& JIO::JReader::operator>> ( long int &  value )

inlineinherited

Definition at line 94 of file JSerialisable.hh.

{ read((char*) &value, sizeof(long int));               return *this; }

operator>>() [10/16]

JReader& JIO::JReader::operator>> ( unsigned long int &  value )

inlineinherited

Definition at line 95 of file JSerialisable.hh.

{ read((char*) &value, sizeof(unsigned long int));      return *this; }

operator>>() [11/16]

JReader& JIO::JReader::operator>> ( long long int &  value )

inlineinherited

Definition at line 96 of file JSerialisable.hh.

{ read((char*) &value, sizeof(long long int));          return *this; }

operator>>() [12/16]

JReader& JIO::JReader::operator>> ( unsigned long long int &  value )

inlineinherited

Definition at line 97 of file JSerialisable.hh.

{ read((char*) &value, sizeof(unsigned long long int)); return *this; }

operator>>() [13/16]

JReader& JIO::JReader::operator>> ( float &  value )

inlineinherited

Definition at line 98 of file JSerialisable.hh.

{ read((char*) &value, sizeof(float));                  return *this; }

operator>>() [14/16]

JReader& JIO::JReader::operator>> ( double &  value )

inlineinherited

Definition at line 99 of file JSerialisable.hh.

{ read((char*) &value, sizeof(double));                 return *this; }

operator>>() [15/16]

JReader& JIO::JReader::operator>> ( long double &  value )

inlineinherited

Definition at line 100 of file JSerialisable.hh.

{ read((char*) &value, sizeof(long double));            return *this; }

operator>>() [16/16]

JReader& JIO::JReader::operator>> ( JLANG::JObjectID &  value )

inlineinherited

Definition at line 101 of file JSerialisable.hh.

{ return (*this) >> value.getID(); }

load() [1/2]

JReader& JIO::JReader::load ( JSerialisable &  object )

inlineinherited

Read object.

Parameters

object

object

Returns

this reader

Definition at line 110 of file JSerialisable.hh.

    {
      return object.read(*this);
    }

load() [2/2]

template<class T >

JReader& JIO::JReader::load ( T &  object )

inlineinherited

Read object.

Parameters

object

object

Returns

this reader

Definition at line 123 of file JSerialisable.hh.

    {
      return *this >> object;
    }

operator bool()

JLANG::JAbstractObjectStatus::operator bool ( ) const

inlineinherited

Type conversion operator.

Returns

status of this object

Definition at line 33 of file JAbstractObjectStatus.hh.

    {
      return this->getStatus();
    }

operator!()

bool JLANG::JAbstractObjectStatus::operator! ( ) const

inlineinherited

Negated status of this object.

Returns

negated status of this object

Definition at line 44 of file JAbstractObjectStatus.hh.

    {
      return !(this->getStatus());
    }

Member Data Documentation

prefix

template<class JPrefix_t >

JPrefix_t JNET::JSocketInputChannel< JPrefix_t >::prefix

Definition at line 171 of file JSocketChannel.hh.

buffer

template<class JPrefix_t >

std::vector<char> JNET::JSocketInputChannel< JPrefix_t >::buffer

private

Definition at line 174 of file JSocketChannel.hh.

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.

__data [1/2]

template<class JElement_t >

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

protectedinherited

Definition at line 104 of file JSocketNonblocking.hh.

__size [1/2]

template<class JElement_t >

int JNET::JSocketBuffer< JElement_t >::__size

protectedinherited

Definition at line 105 of file JSocketNonblocking.hh.

status

JStatus_t JNET::JSocketStatus::status

protectedinherited

Definition at line 115 of file JSocketStatus.hh.

counter

int JNET::JSocketStatus::counter

protectedinherited

Definition at line 116 of file JSocketStatus.hh.

type

JType JNET::JSocketChannel::type

protectedinherited

Definition at line 67 of file JSocketChannel.hh.

__data [2/2]

const char* JIO::JByteArrayReader::__data

protectedinherited

Definition at line 147 of file JByteArrayIO.hh.

__size [2/2]

int JIO::JByteArrayReader::__size

protectedinherited

Definition at line 148 of file JByteArrayIO.hh.

__pos

int JIO::JByteArrayReader::__pos

protectedinherited

Definition at line 149 of file JByteArrayIO.hh.

---

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

• JSocketChannel.hh