---

CAVERNnet_extendedTcpClient_c Class Reference

#include <CAVERNnet_extendedTcp_c.hxx>

Inheritance diagram for CAVERNnet_extendedTcpClient_c::

List of all members.

Public Methods
	CAVERNnet_extendedTcpClient_c ()
virtual	~CAVERNnet_extendedTcpClient_c ()
int	readChar (char &value, int blockingType)
int	writeChar (char value, int blockingType)
int	readInt (int &value, int blockingType)
int	readIntArray (int *intArray, int size, int blockingType)
int	writeInt (int value, int blockingType)
int	writeIntArray (int *intArray, int size, int blockingType)
int	readInt32 (int32 &value, int blockingType)
int	readInt32Array (int32 *int32Array, int size, int blockingType)
int	writeInt32 (int32 value, int blockingType)
int	writeInt32Array (int32 *int32Array, int size, int blockingType)
int	readInt64 (int64 &value, int blockingType)
int	readInt64Array (int64 *int64Array, int size, int blockingType)
int	writeInt64 (int64 value, int blockingType)
int	writeInt64Array (int64 *int64Array, int size, int blockingType)
int	readLong (long &value, int blockingType)
int	readLongArray (long *longArray, int size, int blockingType)
int	writeLong (long value, int blockingType)
int	writeLongArray (long *longArray, int size, int blockingType)
int	readFloat (float &value, int blockingType)
int	readFloatArray (float *floatArray, int size, int blockingType)
int	writeFloat (float value, int blockingType)
int	writeFloatArray (float *floatArray, int size, int blockingType)
int	readDouble (double &value, int blockingType)
int	readDoubleArray (double *doubleArray, int size, int blockingType)
int	writeDouble (double value, int blockingType)
int	writeDoubleArray (double *doubleArray, int size, int blockingType)
Private Attributes
int	int_size
int	char_size
int	int32_size
int	int64_size
int	long_size
int	float_size
int	double_size
char*	int_buffer
char*	int32_buffer
char*	int64_buffer
char*	long_buffer
char*	float_buffer
char*	double_buffer

---

Detailed Description

This class is designed to help users minimize their effort of packing and unpacking numerical values every time they need to send one. All methods provided in this class will pack values before writing them to the network. Again, all methods available in this class will unpack all values gotten from the network before returning them to the users. This class is derived from CAVERNnet_tcp_c class and thus, compatible with the class. So it is possible to use CAVERNnet_extendedTcpClient_c in a machine and use CAVERNnet_tcp_c class in the other, or vice versa; you are just losing the convenience of using simple methods provided in this class in return and you have to pack and unpack by yourself. If you want to use this class in the server side, make sure to create an instance of CAVERNnet_extendedTcpServer_c class instead of CAVERNnet_tcpServer_c since CAVERNnet_extendedTcpServer_c gives you access to all methods available in this client class.

---

Member Function Documentation

int CAVERNnet_extendedTcpClient_c::readChar ( char & value, int blockingType )

reads a character Parameters: value   character you want to write to the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::readDouble ( double & value, int blockingType )

reads a double precision floating point value Parameters: value   double value you want to read from the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::readDoubleArray ( double * doubleArray, int size, int blockingType )

reads a number of double values Parameters: doubleArray   array of double values to store the values read from network stream size   the number of double values you want to send blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::readFloat ( float & value, int blockingType )

reads a single precision floating point value Parameters: value   float value you want to read from the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::readFloatArray ( float * floatArray, int size, int blockingType )

reads a number of float values Parameters: floatArray   array of float values that store the values read from network stream size   the number of float values you want to send blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::readInt ( int & value, int blockingType )

reads an integer value Parameters: value   integer value you want to read from the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::readInt32 ( int32 & value, int blockingType )

reads a 32-bit integer value Parameters: value   32-bit integer value that will be read from the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::readInt32Array ( int32 * int32Array, int size, int blockingType )

reads a number of 32-bit integer values Parameters: int32Array   array of 32-bit integers to store the values read from network stream size   the number of 32-bit integers you want to send blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::readInt64 ( int64 & value, int blockingType )

reads a 64-bit integer value Parameters: value   64-bit integer value that will be read from the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::readInt64Array ( int64 * int64Array, int size, int blockingType )

reads a number of 64-bit integer values Parameters: int64Array   array of 64-bit integers to store the values read from network stream size   the number of 64-bit integers you want to send blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::readIntArray ( int * intArray, int size, int blockingType )

reads a number of integer values Parameters: intArray   array of integers to store the values read from network stream size   the number of integers you want to send blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::readLong ( long & value, int blockingType )

reads a long integer value Parameters: value   long integer value you want to read from the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::readLongArray ( long * longArray, int size, int blockingType )

reads a number of long integer values Parameters: longArray   array of long integers to store the values read from network stream size   the number of long integers you want to send blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::writeChar ( char value, int blockingType )

writes a character Parameters: value   character that is going to be read from the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::writeDouble ( double value, int blockingType )

writes an integer value Parameters: value   double value that is going to be written to the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::writeDoubleArray ( double * doubleArray, int size, int blockingType )

writes a number of double values Parameters: doubleArray   double values that will be sent to the network stream size   the number of double values you want to send blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::writeFloat ( float value, int blockingType )

writes a float value Parameters: value   float value that is going to be written to the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::writeFloatArray ( float * floatArray, int size, int blockingType )

writes a number of float values Parameters: floatArray   float values that will be sent to the network stream size   the number of float values you want to send blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::writeInt ( int value, int blockingType )

writes an integer value Parameters: value   integer value that is going to be written to the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::writeInt32 ( int32 value, int blockingType )

writes a 32-bit integer value Parameters: value   32-bit integer value that is going to be written to the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::writeInt32Array ( int32 * int32Array, int size, int blockingType )

writes a number of 32-bit integer values Parameters: int32Array   32-bit integer values that will be sent to the network stream size   the number of 32-bit integers you want to send blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::writeInt64 ( int64 value, int blockingType )

writes a 64-bit integer value Parameters: value   64-bit integer that is going to be written to the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::writeInt64Array ( int64 * int64Array, int size, int blockingType )

writes a number of 64-bit integer values Parameters: int64Array   64-bit integer values that will be sent to the network stream size   the number of 64-bit integers you want to send blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::writeIntArray ( int * intArray, int size, int blockingType )

writes a number of integer values Parameters: intArray   integer values that will be sent to the network stream size   the number of integers you want to send blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::writeLong ( long value, int blockingType )

writes a long integer value Parameters: value   long integer value that is going to be written to the network stream blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

int CAVERNnet_extendedTcpClient_c::writeLongArray ( long * longArray, int size, int blockingType )

writes a number of long integer values Parameters: longArray   long integer values that will be sent to the network stream size   the number of long integers you want to send blockingType   either CAVERNnet_tcpClient_c::BLOCKING for blocking operation or CAVERNnet_tcpClient_c::NON_BLOCKING for non-blocking operation

---

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

• CAVERNnet_extendedTcp_c.hxx

---