JNET::JSocketBuffer< JElement_t > Class Template Reference

Auxiliary class for non-blocking socket I/O. More...

#include <JSocketNonblocking.hh>

Inheritance diagram for JNET::JSocketBuffer< JElement_t >:

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

Public Member Functions
	JSocketBuffer (JElement_t *buffer, const int length)
	Constructor.
int	getSize () const
	Get size of pending data.
void	set (const JSocketBuffer< JElement_t > &buffer)
	Initialise buffer.
void	set (JElement_t *buffer, const int length)
	Initialise buffer.
void	reset ()
	Reset.
JStatus_t	getStatus () const
	Get status of I/O.
bool	isReset () const
	Check reset status.
bool	isBusy () const
	Check busy status.
bool	isReady () const
	Check ready status.
int	getCounter () const
	Get number of I/O attempts.

Protected Member Functions
	JSocketBuffer ()
	Default constructor.
void	setStatus (const JStatus_t status)
	Set status of I/O.

Protected Attributes
JElement_t *	__data
int	__size
JStatus_t	status
int	counter

Detailed Description

template<class JElement_t>
class JNET::JSocketBuffer< JElement_t >

Auxiliary class for non-blocking socket I/O.

Definition at line 22 of file JSocketNonblocking.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 };

Constructor & Destructor Documentation

JSocketBuffer() [1/2]

template<class JElement_t >

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

inlineprotected

Default constructor.

Definition at line 29 of file JSocketNonblocking.hh.

                    :
      JSocketStatus(),
      __data(NULL),
      __size(0)
    {}

JSocketBuffer() [2/2]

template<class JElement_t >

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

inline

Constructor.

Parameters

buffer	I/O data
length	number of bytes

Definition at line 43 of file JSocketNonblocking.hh.

                                                        :
      JSocketStatus(),
      __data(buffer),
      __size(length)
    {}

Member Function Documentation

getSize()

template<class JElement_t >

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

inline

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 )

inline

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 )

inline

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

reset()

template<class JElement_t >

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

inline

Reset.

Definition at line 94 of file JSocketNonblocking.hh.

    {
      JSocketStatus::reset();
 
      __data  = NULL;
      __size  = 0;
    }

getStatus()

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

Member Data Documentation

__data

template<class JElement_t >

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

protected

Definition at line 104 of file JSocketNonblocking.hh.

__size

template<class JElement_t >

int JNET::JSocketBuffer< JElement_t >::__size

protected

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.

---

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

• JSocketNonblocking.hh