The IGI Message. More...

Public Types
enum	DataType { Unknown = 0, Char = 1 \| packSizeOf(char), UnsignedChar = 2 \| packSizeOf(unsigned char), Short = 3 \| packSizeOf(short), UnsignedShort = 4 \| packSizeOf(unsigned short), Int = 5 \| packSizeOf(int), UnsignedInt = 6 \| packSizeOf(unsigned int), Float = 7 \| packSizeOf(float), LongLong = 8 \| packSizeOf(long long), UnsignedLongLong = 9 \| packSizeOf(unsigned long long), Double = 10 \| packSizeOf(double), Bool = 11 \| packSizeOf(bool), Long = 12 \| packSizeOf(long), UnsignedLong = 13 \| packSizeOf(unsigned long), String = 128, FixedArray = 129, UnicodeString = 130, User_Start = 150, User_Last = 255 }

typedef unsigned char	Byte

typedef std::vector< Byte, tbb::tbb_allocator< Byte > >	ByteBuffer

Public Member Functions
	DtMessage (unsigned short classId=0, unsigned short functionId=0)
	Byte 0: DataType Id. More...

	DtMessage (const Byte *buffer, size_t size)
	Construct a message from a raw buffer, the raw buffer MUST have come from another IGI message, typically due to the fact it was transfered to a separate client process. More...

	DtMessage (const DtMessage &orig)
	CTOR. More...

	~DtMessage ()
	DTOR. More...

void	printDebugMessageContents (std::ostream &)
	Print the message contents for debugging. More...

const char *	dataTypeName (unsigned char dataType)
	Get the name of a data type in English. More...

unsigned short	classId () const
	Get the class id. More...

unsigned short	functionId () const
	Get the function id. More...

const Byte *	data () const
	Get a pointer to the start of the data. More...

size_t	size () const
	Get the current size of the message in bytes. More...

void	emptyMessage ()
	Empty the message. This does NOT dealloc memory. More...

void	resetRead ()
	Reset the internal reader to the beginning of data. More...

void	serializeHeader (unsigned short classId, unsigned short functionId)
	If the message is set to write out, this will verify that the input class id and the function id match those in the message, if the message is set to read in data, it will set the class id and function id. More...

bool	serializeWriteOut () const
	Is this message set to write out data during serialization or read in data. More...

void	setSerializeWriteOut (bool writeOut)
	Set whether the message will write out data during serialization or read in data. More...

void	addOnlyData (DtMessage &message)
	Adds only the data from the message (no header). More...

void	addData (unsigned int dataType, const void *data, int dataSize)
	Low level add data call. More...

bool	canReadData () const
	Get if there is more data that can be read. More...

unsigned char	nextDataType () const
	Get the type of the next data in the message. More...

unsigned int	nextDataSize () const
	Get the data size of the next parameter to be read. More...

const void *	nextDataPointer () const
	Get a pointer to the next chunk of data. More...

void	skipToNextData ()
	Move the read pointer to the next data element in the message. More...

void	advanceRead (size_t bytes)
	Move the read pointer forward a number of bytes. More...

void	getData (int dataType, void *output)
	Read the next parameter into the output. More...


DtMessage &	operator>> (bool &b)
	Read data parameters. More...

DtMessage &	operator>> (char &c)

DtMessage &	operator>> (unsigned char &c)

DtMessage &	operator>> (short &i)

DtMessage &	operator>> (unsigned short &i)

DtMessage &	operator>> (int &i)

DtMessage &	operator>> (unsigned int &i)

DtMessage &	operator>> (long long &i)

DtMessage &	operator>> (unsigned long long &i)

DtMessage &	operator>> (float &f)

DtMessage &	operator>> (double &f)

DtMessage &	operator>> (long &i)

DtMessage &	operator>> (unsigned long &i)

DtMessage &	operator>> (std::string &s)

DtMessage &	operator>> (DtUnicode &s)

DtMessage &	operator>> (ByteBuffer &rawData)

DtMessage &	operator>> (std::pair< void *, int > &rawData)
	Note that this will allocate new memory (char*) and return it in the first member. More...


DtMessage &	operator<< (bool b)
	Add data parameters. More...

DtMessage &	operator<< (char c)

DtMessage &	operator<< (unsigned char c)

DtMessage &	operator<< (short i)

DtMessage &	operator<< (unsigned short i)

DtMessage &	operator<< (int i)

DtMessage &	operator<< (unsigned int i)

DtMessage &	operator<< (long long i)

DtMessage &	operator<< (unsigned long long i)

DtMessage &	operator<< (float f)

DtMessage &	operator<< (double f)

DtMessage &	operator<< (long i)

DtMessage &	operator<< (unsigned long i)

DtMessage &	operator<< (const std::string &s)

DtMessage &	operator<< (const DtUnicode &s)

DtMessage &	operator<< (const char *str)

DtMessage &	operator<< (const ByteBuffer &rawData)

DtMessage &	operator<< (const std::pair< void *, int > &rawData)

Static Public Attributes
static const int	theHeaderSize = (sizeof(unsigned short) + sizeof(char)) * 2

ByteBuffer	myBuffer

ByteBuffer::const_iterator	myReadIter

bool	mySerializeWriteOutFlag

void	addMultiple ()
	Helper functions for doing multiple adds and reads. More...

template<typename T1 >
void	addMultiple (T1 t1)

template<typename T1 , typename T2 >
void	addMultiple (T1 t1, T2 t2)

template<typename T1 , typename T2 , typename T3 >
void	addMultiple (T1 t1, T2 t2, T3 t3)

template<typename T1 , typename T2 , typename T3 , typename T4 >
void	addMultiple (T1 t1, T2 t2, T3 t3, T4 t4)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
void	addMultiple (T1 t1, T2 t2, T3 t3, T4 t4, T5 t5)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 >
void	addMultiple (T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 >
void	addMultiple (T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 , typename T8 >
void	addMultiple (T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7, T8 t8)

void	readMultiple ()

template<typename T1 >
void	readMultiple (T1 &t1)

template<typename T1 , typename T2 >
void	readMultiple (T1 &t1, T2 &t2)

template<typename T1 , typename T2 , typename T3 >
void	readMultiple (T1 &t1, T2 &t2, T3 &t3)

template<typename T1 , typename T2 , typename T3 , typename T4 >
void	readMultiple (T1 &t1, T2 &t2, T3 &t3, T4 &t4)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
void	readMultiple (T1 &t1, T2 &t2, T3 &t3, T4 &t4, T5 &t5)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 >
void	readMultiple (T1 &t1, T2 &t2, T3 &t3, T4 &t4, T5 &t5, T6 &t6)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 >
void	readMultiple (T1 &t1, T2 &t2, T3 &t3, T4 &t4, T5 &t5, T6 &t6, T7 &t7)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 , typename T8 >
void	readMultiple (T1 &t1, T2 &t2, T3 &t3, T4 &t4, T5 &t5, T6 &t6, T7 &t7, T8 &t8)

template<typename T1 >
void	serialize (T1 &t1)

template<typename T1 , typename T2 >
void	serialize (T1 &t1, T2 &t2)

template<typename T1 , typename T2 , typename T3 >
void	serialize (T1 &t1, T2 &t2, T3 &t3)

template<typename T1 , typename T2 , typename T3 , typename T4 >
void	serialize (T1 &t1, T2 &t2, T3 &t3, T4 &t4)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >
void	serialize (T1 &t1, T2 &t2, T3 &t3, T4 &t4, T5 &t5)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 >
void	serialize (T1 &t1, T2 &t2, T3 &t3, T4 &t4, T5 &t5, T6 &t6)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 >
void	serialize (T1 &t1, T2 &t2, T3 &t3, T4 &t4, T5 &t5, T6 &t6, T7 &t7)

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 , typename T8 >
void	serialize (T1 &t1, T2 &t2, T3 &t3, T4 &t4, T5 &t5, T6 &t6, T7 &t7, T8 &t8)

template<typename T >
void	serializeViaArchive (T &t)

void	setClassId (unsigned short classId)
	Set the class id. More...

void	setFunctionId (unsigned short functionId)
	Set the function id. More...

Detailed Description

The IGI Message.

Is easily encoded and decoding using stream operators. It also provides validation during decoding of binary data for both type and size. It is also extensible allowing for additional types.

Member Typedef Documentation

typedef unsigned char makVrv::DtMessage::Byte

typedef std::vector<Byte, tbb::tbb_allocator<Byte> > makVrv::DtMessage::ByteBuffer

Member Enumeration Documentation

enum makVrv::DtMessage::DataType

Enumerator
Unknown
Char
UnsignedChar
Short
UnsignedShort
Int
UnsignedInt
Float
LongLong
UnsignedLongLong
Double
Bool
Long
UnsignedLong
String
FixedArray
UnicodeString
User_Start
User_Last

Constructor & Destructor Documentation

makVrv::DtMessage::DtMessage	(	unsigned short	classId = `0`,
		unsigned short	functionId = `0`
	)

Byte 0: DataType Id.

If DataType is a simple type (value type, int,double etc). Byte 1-n: Where n is 1-8, depending on the datatype is If DataType is a complex type (binary chunk w/ size) Byte 1-4: Is a 32bit integer which is the size of the data (in bytes). Byte 5-(5 + size): The size bytes. Default CTOR By default this message will be initialized to do reading input and writing to the message during serialization.

makVrv::DtMessage::DtMessage	(	const Byte *	buffer,
		size_t	size
	)

Construct a message from a raw buffer, the raw buffer MUST have come from another IGI message, typically due to the fact it was transfered to a separate client process.

By default this message will be initialized to do reading data from the message and writing to the input during serialization.

makVrv::DtMessage::DtMessage ( const DtMessage & orig )

CTOR.

Note that the internal read pointer is also copied, in addition to the data.

makVrv::DtMessage::~DtMessage ( )

DTOR.

Member Function Documentation

void makVrv::DtMessage::printDebugMessageContents ( std::ostream & )

Print the message contents for debugging.

const char* makVrv::DtMessage::dataTypeName ( unsigned char dataType )

Get the name of a data type in English.

unsigned short makVrv::DtMessage::classId ( ) const

Get the class id.

unsigned short makVrv::DtMessage::functionId ( ) const

Get the function id.

const Byte* makVrv::DtMessage::data ( ) const

Get a pointer to the start of the data.

size_t makVrv::DtMessage::size ( ) const

Get the current size of the message in bytes.

Referenced by makVrf::operator<<().

void makVrv::DtMessage::emptyMessage ( )

Empty the message. This does NOT dealloc memory.

void makVrv::DtMessage::resetRead ( )

Reset the internal reader to the beginning of data.

This does not include the internal message header.

void makVrv::DtMessage::serializeHeader	(	unsigned short	classId,
		unsigned short	functionId
	)

If the message is set to write out, this will verify that the input class id and the function id match those in the message, if the message is set to read in data, it will set the class id and function id.

bool makVrv::DtMessage::serializeWriteOut ( ) const

Is this message set to write out data during serialization or read in data.

void makVrv::DtMessage::setSerializeWriteOut ( bool writeOut )

Set whether the message will write out data during serialization or read in data.

DtMessage& makVrv::DtMessage::operator>> ( bool & b )

Read data parameters.

Each call moves the internal data pointers. throws exceptions on errors.

DtMessage& makVrv::DtMessage::operator>> ( char & c )

DtMessage& makVrv::DtMessage::operator>> ( unsigned char & c )

DtMessage& makVrv::DtMessage::operator>> ( short & i )

DtMessage& makVrv::DtMessage::operator>> ( unsigned short & i )

DtMessage& makVrv::DtMessage::operator>> ( int & i )

DtMessage& makVrv::DtMessage::operator>> ( unsigned int & i )

DtMessage& makVrv::DtMessage::operator>> ( long long & i )

DtMessage& makVrv::DtMessage::operator>> ( unsigned long long & i )

DtMessage& makVrv::DtMessage::operator>> ( float & f )

DtMessage& makVrv::DtMessage::operator>> ( double & f )

DtMessage& makVrv::DtMessage::operator>> ( long & i )

DtMessage& makVrv::DtMessage::operator>> ( unsigned long & i )

DtMessage& makVrv::DtMessage::operator>> ( std::string & s )

DtMessage& makVrv::DtMessage::operator>> ( DtUnicode & s )

DtMessage& makVrv::DtMessage::operator>> ( ByteBuffer & rawData )

DtMessage& makVrv::DtMessage::operator>> ( std::pair< void *, int > & rawData )

Note that this will allocate new memory (char*) and return it in the first member.

DtMessage& makVrv::DtMessage::operator<< ( bool b )

Add data parameters.

DtMessage& makVrv::DtMessage::operator<< ( char c )

DtMessage& makVrv::DtMessage::operator<< ( unsigned char c )

DtMessage& makVrv::DtMessage::operator<< ( short i )

DtMessage& makVrv::DtMessage::operator<< ( unsigned short i )

DtMessage& makVrv::DtMessage::operator<< ( int i )

DtMessage& makVrv::DtMessage::operator<< ( unsigned int i )

DtMessage& makVrv::DtMessage::operator<< ( long long i )

DtMessage& makVrv::DtMessage::operator<< ( unsigned long long i )

DtMessage& makVrv::DtMessage::operator<< ( float f )

DtMessage& makVrv::DtMessage::operator<< ( double f )

DtMessage& makVrv::DtMessage::operator<< ( long i )

DtMessage& makVrv::DtMessage::operator<< ( unsigned long i )

DtMessage& makVrv::DtMessage::operator<< ( const std::string & s )

DtMessage& makVrv::DtMessage::operator<< ( const DtUnicode & s )

DtMessage& makVrv::DtMessage::operator<< ( const char * str )

DtMessage& makVrv::DtMessage::operator<< ( const ByteBuffer & rawData )

DtMessage& makVrv::DtMessage::operator<< ( const std::pair< void *, int > & rawData )

void makVrv::DtMessage::addOnlyData ( DtMessage & message )

Adds only the data from the message (no header).

void makVrv::DtMessage::addData	(	unsigned int	dataType,
		const void *	data,
		int	dataSize
	)

Low level add data call.

bool makVrv::DtMessage::canReadData ( ) const

Get if there is more data that can be read.

unsigned char makVrv::DtMessage::nextDataType ( ) const

Get the type of the next data in the message.

Exceptions

DtCorruptedState if there is no next data.

unsigned int makVrv::DtMessage::nextDataSize ( ) const

Get the data size of the next parameter to be read.

NOTE! the reader pointer must be pointing to the beginning of a parameter in the buffer.

Exceptions

DtCorruptedState if there is no next data.

const void* makVrv::DtMessage::nextDataPointer ( ) const

Get a pointer to the next chunk of data.

Do not modify the data in this pointer.

void makVrv::DtMessage::skipToNextData ( )

Move the read pointer to the next data element in the message.

void makVrv::DtMessage::advanceRead ( size_t bytes )

Move the read pointer forward a number of bytes.

Warning: This is a potentially very dangerous function if used incorrectly.

void makVrv::DtMessage::getData	(	int	dataType,
		void *	output
	)

Read the next parameter into the output.

It is assumed that output has sufficient space, use getDataSize before calling to ensure this. This function also moves the current read pointer.

void makVrv::DtMessage::addMultiple ( )

inline

Helper functions for doing multiple adds and reads.

template<typename T1 >

void makVrv::DtMessage::addMultiple ( T1 t1 )

inline

template<typename T1 , typename T2 >

void makVrv::DtMessage::addMultiple	(	T1	t1,
		T2	t2
	)

inline

template<typename T1 , typename T2 , typename T3 >

void makVrv::DtMessage::addMultiple	(	T1	t1,
		T2	t2,
		T3	t3
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 >

void makVrv::DtMessage::addMultiple	(	T1	t1,
		T2	t2,
		T3	t3,
		T4	t4
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >

void makVrv::DtMessage::addMultiple	(	T1	t1,
		T2	t2,
		T3	t3,
		T4	t4,
		T5	t5
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 >

void makVrv::DtMessage::addMultiple	(	T1	t1,
		T2	t2,
		T3	t3,
		T4	t4,
		T5	t5,
		T6	t6
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 >

void makVrv::DtMessage::addMultiple	(	T1	t1,
		T2	t2,
		T3	t3,
		T4	t4,
		T5	t5,
		T6	t6,
		T7	t7
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 , typename T8 >

void makVrv::DtMessage::addMultiple	(	T1	t1,
		T2	t2,
		T3	t3,
		T4	t4,
		T5	t5,
		T6	t6,
		T7	t7,
		T8	t8
	)

inline

void makVrv::DtMessage::readMultiple ( )

inline

template<typename T1 >

void makVrv::DtMessage::readMultiple ( T1 & t1 )

inline

template<typename T1 , typename T2 >

void makVrv::DtMessage::readMultiple	(	T1 &	t1,
		T2 &	t2
	)

inline

template<typename T1 , typename T2 , typename T3 >

void makVrv::DtMessage::readMultiple	(	T1 &	t1,
		T2 &	t2,
		T3 &	t3
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 >

void makVrv::DtMessage::readMultiple	(	T1 &	t1,
		T2 &	t2,
		T3 &	t3,
		T4 &	t4
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >

void makVrv::DtMessage::readMultiple	(	T1 &	t1,
		T2 &	t2,
		T3 &	t3,
		T4 &	t4,
		T5 &	t5
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 >

void makVrv::DtMessage::readMultiple	(	T1 &	t1,
		T2 &	t2,
		T3 &	t3,
		T4 &	t4,
		T5 &	t5,
		T6 &	t6
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 >

void makVrv::DtMessage::readMultiple	(	T1 &	t1,
		T2 &	t2,
		T3 &	t3,
		T4 &	t4,
		T5 &	t5,
		T6 &	t6,
		T7 &	t7
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 , typename T8 >

void makVrv::DtMessage::readMultiple	(	T1 &	t1,
		T2 &	t2,
		T3 &	t3,
		T4 &	t4,
		T5 &	t5,
		T6 &	t6,
		T7 &	t7,
		T8 &	t8
	)

inline

template<typename T1 >

void makVrv::DtMessage::serialize ( T1 & t1 )

inline

template<typename T1 , typename T2 >

void makVrv::DtMessage::serialize	(	T1 &	t1,
		T2 &	t2
	)

inline

template<typename T1 , typename T2 , typename T3 >

void makVrv::DtMessage::serialize	(	T1 &	t1,
		T2 &	t2,
		T3 &	t3
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 >

void makVrv::DtMessage::serialize	(	T1 &	t1,
		T2 &	t2,
		T3 &	t3,
		T4 &	t4
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 >

void makVrv::DtMessage::serialize	(	T1 &	t1,
		T2 &	t2,
		T3 &	t3,
		T4 &	t4,
		T5 &	t5
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 >

void makVrv::DtMessage::serialize	(	T1 &	t1,
		T2 &	t2,
		T3 &	t3,
		T4 &	t4,
		T5 &	t5,
		T6 &	t6
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 >

void makVrv::DtMessage::serialize	(	T1 &	t1,
		T2 &	t2,
		T3 &	t3,
		T4 &	t4,
		T5 &	t5,
		T6 &	t6,
		T7 &	t7
	)

inline

template<typename T1 , typename T2 , typename T3 , typename T4 , typename T5 , typename T6 , typename T7 , typename T8 >

void makVrv::DtMessage::serialize	(	T1 &	t1,
		T2 &	t2,
		T3 &	t3,
		T4 &	t4,
		T5 &	t5,
		T6 &	t6,
		T7 &	t7,
		T8 &	t8
	)

inline

template<typename T >

void makVrv::DtMessage::serializeViaArchive ( T & t )

inline

void makVrv::DtMessage::setClassId ( unsigned short classId )

protected

Set the class id.

void makVrv::DtMessage::setFunctionId ( unsigned short functionId )

protected

Set the function id.

Member Data Documentation

const int makVrv::DtMessage::theHeaderSize = (sizeof(unsigned short) + sizeof(char)) * 2

static

ByteBuffer makVrv::DtMessage::myBuffer

protected

ByteBuffer::const_iterator makVrv::DtMessage::myReadIter

protected

bool makVrv::DtMessage::mySerializeWriteOutFlag

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrvUtil/DtMessage.h

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation