TCPmessage Class Reference

This class defines a modular message to be passed over TCP connections. More...

#include <Beowulf/TCPmessage.H>

Collaboration diagram for TCPmessage:

Classes
struct	TCPmessageHeader
	This private struct is the common header in all TCPmessage objects.
Public Member Functions
	TCPmessage ()
	uninitialized constructor (for pointers)
	TCPmessage (const int32 msgid, const int32 msgaction, const float msgeti=0.0F)
	constructor with empty message body
	TCPmessage (const int32 msgid, const int32 msgaction, const float msgeti, const void *buf, const int bufsize)
	constructor with copy of given message body
	TCPmessage (const TCPmessage &m)
	copy constructor
TCPmessage &	operator= (const TCPmessage &m)
	assignment
	~TCPmessage ()
	destructor
void	addImage (const Image< PixRGB< byte > > &im)
	method to add elements into a message to be sent out
void	addImage (const Image< byte > &im)
	method to add elements into a message to be sent out
void	addImage (const Image< float > &im)
	method to add elements into a message to be sent out
void	addImageSet (const ImageSet< float > &im)
	method to add elements into a message to be sent out
void	addFixation (const Fixation &fix)
	method to add elements into a message to be sent out
void	addString (const char *str)
	method to add elements into a message to be sent out
void	addInt32 (const int32 val)
	method to add elements into a message to be sent out
void	addFloat (const float val)
	method to add elements into a message to be sent out
void	addDouble (const double val)
	method to add elements into a message to be sent out
void	addInt64 (const int64 val)
	method to add elements into a message to be sent out
void	setID (const int32 id)
	modify message ID
int32	getID () const
	get message ID
void	setAction (const int32 ac)
	modify message action
int32	getAction () const
	get message action
void	setETI (const float eti)
	modify message eti (estimated time to idle)
float	getETI () const
	get message eti (estimated time to idle)
int32	getSize () const
	get total message size (mostly for debuging purposes)
bool	isBusy () const
	check whether message is busy (sending or receiving data):
void	reset (const int32 msgid, const int32 msgaction, const float msgeti=0.0F)
	empty old contents and get ready for a re-use:
void	freeMem ()
	free memory:
void	getElementRaw (void **elem, int32 &typ)
	DONT'T USE THIS; use one of the type-specific getElement functions below.
Image< PixRGB< byte > >	getElementColByteIma ()
	Get a color byte image from the message stream.
Image< byte >	getElementByteIma ()
	Get a byte image from the message stream.
Image< float >	getElementFloatIma ()
	Get a float image from the message stream.
ImageSet< float >	getElementFloatImaSet ()
	Get a float image set from the message stream.
int32	getElementInt32 ()
	Get an int32 value from the message stream.
int64	getElementInt64 ()
	Get an int64 value from the message stream.
double	getElementDouble ()
	Get a double value from the message stream.
float	getElementFloat ()
	Get a float value from the message stream.
Fixation	getElementFixation ()
	Get a Fixation from the message stream.
std::string	getElementString ()
	Get a string value from the message stream.
template<class T >
void	unpack (const T *data, const int nitem)
	unpack some data from message (memory must be pre-allocated):
Friends
class	TCPcliServ
	make our private methods accessible to TCPcliServ:

Detailed Description

This class defines a modular message to be passed over TCP connections.

The basic message structure is as follows:

one TCPmessageHeader (see private section of TCPmessage definition)
[repeat as needed:]
field type (int32)
field data (size and type depending on field type)
field type = TCPMSG_END CAUTION: to optimize speed, there is no semaphore when modifying the contents of the message (e.g., adding fields) or when parsing it. So, be careful with multi-threaded uses!

Definition at line 92 of file TCPmessage.H.

Constructor & Destructor Documentation

TCPmessage::TCPmessage ( )

uninitialized constructor (for pointers)

Definition at line 56 of file TCPmessage.C.

References reset().

TCPmessage::TCPmessage	(	const int32	msgid,
		const int32	msgaction,
		const float	msgeti = `0.0F`
	)

constructor with empty message body

Parameters:

	msgid	a message identification (user-defined)
	msgaction	additional field where users can specify an action to be executed when this message is received
	msgeti	estimated time to idle, in seconds. This is used for automatic load balancing, where the Beowulf class will dispatch processing to nodes with shorter eti's in priority, when a load-balanced send is requested. If you are not doing load balancing, just use the default of 0.0.

Definition at line 61 of file TCPmessage.C.

References reset().

TCPmessage::TCPmessage	(	const int32	msgid,
		const int32	msgaction,
		const float	msgeti,
		const void *	buf,
		const int	bufsize
	)

constructor with copy of given message body

NOTE: we do a deep copy of the given buffer, so that it can be freed immediately upon return from this constructor

Definition at line 67 of file TCPmessage.C.

References reset().

TCPmessage::TCPmessage ( const TCPmessage & m )

copy constructor

Definition at line 79 of file TCPmessage.C.

TCPmessage::~TCPmessage ( )

destructor

Definition at line 92 of file TCPmessage.C.