cMsg Messaging System  6.0
 All Classes Namespaces Files Functions Variables Friends
cmsg::cMsgMessage Class Reference

Class for wrapping cMsg message. More...

#include <cMsg.hxx>

Public Member Functions

 cMsgMessage (void) throw (cMsgException)
 Default constructor creates message. More...
 
 cMsgMessage (const cMsgMessage &m) throw (cMsgException)
 Copy constructor creates message object from another message object. More...
 
 cMsgMessage (void *msgPointer) throw (cMsgException)
 Constructor creates message object from C message pointer. More...
 
virtual ~cMsgMessage (void)
 Destructor frees C message pointer struct. More...
 
virtual string getSubject (void) const throw (cMsgException)
 Gets message subject. More...
 
virtual void setSubject (const string &subject) throw (cMsgException)
 Sets message subject. More...
 
virtual string getType (void) const throw (cMsgException)
 Gets message type. More...
 
virtual void setType (const string &type) throw (cMsgException)
 Sets message type. More...
 
virtual string getText (void) const throw (cMsgException)
 Gets message text. More...
 
virtual void setText (const string &text) throw (cMsgException)
 Sets message text. More...
 
virtual void setByteArrayLength (int length) throw (cMsgException)
 Sets message region-of-interest byte array length. More...
 
virtual void resetByteArrayLength ()
 Sets message region-of-interest byte array length to the full length of the array. More...
 
virtual int getByteArrayLength (void)
 Gets message region-of-interest byte array length. More...
 
virtual int getByteArrayLengthFull (void)
 Gets message full byte array length. More...
 
virtual void setByteArrayOffset (int offset) throw (cMsgException)
 Specifies offset in byte array. More...
 
virtual int getByteArrayOffset (void)
 Gets offset in byte array. More...
 
virtual int getByteArrayEndian (void)
 Gets endian-ness of message byte array. More...
 
virtual void setByteArrayEndian (int endian) throw (cMsgException)
 Sets endian-ness of message byte array. More...
 
virtual bool needToSwap (void) const throw (cMsgException)
 True if need to swap byte array. More...
 
virtual char * getByteArray (void)
 Gets byte array. More...
 
virtual void setByteArray (char *array, int length) throw (cMsgException)
 Specifies byte array by copying it. More...
 
virtual void setByteArrayNoCopy (char *array, int length) throw (cMsgException)
 Specifies the byte array by only copying the pointer to the array. More...
 
virtual int getUserInt (void) const throw (cMsgException)
 Gets message user int. More...
 
virtual void setUserInt (int i) throw (cMsgException)
 Sets message user int. More...
 
virtual struct timespec getUserTime (void) const throw (cMsgException)
 Gets message user time. More...
 
virtual void setUserTime (const struct timespec &userTime) throw (cMsgException)
 Sets message user time. More...
 
virtual int getVersion (void) const throw (cMsgException)
 Gets cMsg version. More...
 
virtual string getDomain (void) const throw (cMsgException)
 Gets message domain. More...
 
virtual string getReceiver (void) const throw (cMsgException)
 Gets message receiver. More...
 
virtual string getReceiverHost (void) const throw (cMsgException)
 Gets message receiver host. More...
 
virtual string getSender (void) const throw (cMsgException)
 Gets message sender. More...
 
virtual string getSenderHost (void) const throw (cMsgException)
 Gets message sender host. More...
 
virtual struct timespec getReceiverTime (void) const throw (cMsgException)
 Gets message receiver time. More...
 
virtual struct timespec getSenderTime (void) const throw (cMsgException)
 Gets message sender time. More...
 
virtual bool isGetRequest (void) const throw (cMsgException)
 True if message is a get request. More...
 
virtual bool isGetResponse (void) const throw (cMsgException)
 True if message is a get response. More...
 
virtual bool isNullGetResponse (void) const throw (cMsgException)
 True if message is a NULL get response. More...
 
virtual void makeNullResponse (const cMsgMessage &msg) throw (cMsgException)
 Makes a message a null response message. More...
 
virtual void makeNullResponse (const cMsgMessage *msg) throw (cMsgException)
 Makes a message a null response message. More...
 
virtual void makeResponse (const cMsgMessage &msg) throw (cMsgException)
 Makes a message a response message. More...
 
virtual void makeResponse (const cMsgMessage *msg) throw (cMsgException)
 Makes a message a response message. More...
 
virtual void setGetResponse (bool b) throw (cMsgException)
 Makes message a get response message. More...
 
virtual void setNullGetResponse (bool b) throw (cMsgException)
 Makes message a null response message. More...
 
virtual string toString (void) const throw (cMsgException)
 Gets xml representation of message. More...
 
virtual cMsgMessagecopy (void) const throw (cMsgException)
 Copies a message. More...
 
virtual cMsgMessagenullResponse (void) const throw (cMsgException)
 Creates a null response message. More...
 
virtual cMsgMessageresponse (void) const throw (cMsgException)
 Creates a response message. More...
 
virtual string getSubscriptionDomain () const throw (cMsgException)
 Gets subscription domain. More...
 
virtual string getSubscriptionSubject () const throw (cMsgException)
 Gets subscription subject. More...
 
virtual string getSubscriptionType () const throw (cMsgException)
 Gets subscription type. More...
 
virtual string getSubscriptionUDL () const throw (cMsgException)
 Gets subscription UDL. More...
 
virtual int getSubscriptionCueSize (void) const throw (cMsgException)
 Gets current subscription cue size. More...
 
virtual bool getReliableSend (void) const throw (cMsgException)
 True if message sent via reliable send. More...
 
virtual void setReliableSend (bool b) throw (cMsgException)
 Sets message reliable send flag. More...
 
virtual bool hasPayload () const
 This method returns whether a message has a compound payload or not. More...
 
virtual void payloadClear (void)
 This method removes all the user-added items in the payload. More...
 
virtual void payloadReset (void)
 This method removes all items (including those added by the cMsg system) in the payload. More...
 
virtual void payloadPrint (void) const
 This method prints out the message payload in a readable form. More...
 
virtual void payloadCopy (const cMsgMessage &msg) throw (cMsgException)
 This method copies the payload from another message. More...
 
virtual bool payloadRemoveField (const string &name)
 This method removes the named field if its exists. More...
 
virtual string payloadGetText () const
 This method returns a text representation of the payload. More...
 
virtual void payloadSetFromText (const string &txt) throw (cMsgException)
 This method takes a string returned from payloadGetText as an argument and constructs a payload out of it. More...
 
virtual string payloadGetFieldDescription (const string &name) const throw (cMsgException)
 This method returns a description of the given field name in the payload. More...
 
virtual map< string, int > * payloadGet () const throw (cMsgException)
 This method returns a pointer to a map containing all name/type pairs of the payload. More...
 
virtual int payloadGetCount () const
 This method returns the number of payload items a message has. More...
 
virtual bool payloadContainsName (const string &name) const
 This method returns whether an item in the payload has the given name or not. More...
 
virtual int payloadGetType (const string &name) const throw (cMsgException)
 This method returns the type of data associated with the payload field given by the name argument. More...
 
virtual void setHistoryLengthMax (int len) const throw (cMsgException)
 This method sets the maximum number of entries this message keeps of its history of various parameters (sender's name, host, time). More...
 
virtual void getBinary (const string &name, const char **val, int &len, int &endian) const throw (cMsgException)
 This method returns the value of the given field as a binary array if it exists. More...
 
virtual void getBinaryArray (const string &name, const char ***vals, int **lens, int **endians, int &count) const throw (cMsgException)
 This method returns the value of the given field as a binary array if it exists. More...
 
virtual cMsgMessagegetMessage (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a cMsgMessage object pointer if its exists. More...
 
virtual vector< cMsgMessage > * getMessageVector (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to a vector of cMsgMessage objects, if its exists. More...
 
virtual vector< cMsgMessage * > * getMessagePVector (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to a vector of pointers to cMsgMessage objects, if its exists. More...
 
virtual cMsgMessagegetMessageArray (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to an array of cMsgMessage objects, if it exists. More...
 
virtual cMsgMessage ** getMessagePArray (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to an array of pointers to cMsgMessage objects, if it exists. More...
 
virtual string getString (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a string if its exists. More...
 
virtual vector< string > * getStringVector (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to a vector of strings if its exists. More...
 
virtual string * getStringArray (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to an array of strings if its exists. More...
 
virtual float getFloat (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a float if its exists. More...
 
virtual vector< float > * getFloatVector (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to a vector of floats if its exists. More...
 
virtual float * getFloatArray (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to an array of floats if its exists. More...
 
virtual double getDouble (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a double if its exists. More...
 
virtual vector< double > * getDoubleVector (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to a vector of doubles if its exists. More...
 
virtual double * getDoubleArray (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an array of doubles if its exists. More...
 
virtual int8_t getInt8 (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an 8 bit, signed integer if its exists. More...
 
virtual int16_t getInt16 (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an 16 bit, signed integer if its exists. More...
 
virtual int32_t getInt32 (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an 32 bit, signed integer if its exists. More...
 
virtual int64_t getInt64 (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an 64 bit, signed integer if its exists. More...
 
virtual vector< int8_t > * getInt8Vector (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to a vector of 8-bit, signed ints if its exists. More...
 
virtual vector< int16_t > * getInt16Vector (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to a vector of 16-bit, signed ints if its exists. More...
 
virtual vector< int32_t > * getInt32Vector (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to a vector of 32-bit, signed ints if its exists. More...
 
virtual vector< int64_t > * getInt64Vector (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to a vector of 64-bit, signed ints if its exists. More...
 
virtual int8_t * getInt8Array (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an array of 8-bit, signed ints if its exists. More...
 
virtual int16_t * getInt16Array (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an array of 16-bit, signed ints if its exists. More...
 
virtual int32_t * getInt32Array (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an array of 32-bit, signed ints if its exists. More...
 
virtual int64_t * getInt64Array (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an array of 64-bit, signed ints if its exists. More...
 
virtual uint8_t getUint8 (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an 8 bit, unsigned integer if its exists. More...
 
virtual uint16_t getUint16 (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an 16 bit, unsigned integer if its exists. More...
 
virtual uint32_t getUint32 (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an 32 bit, unsigned integer if its exists. More...
 
virtual uint64_t getUint64 (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an 64 bit, unsigned integer if its exists. More...
 
virtual vector< uint8_t > * getUint8Vector (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to a vector of 8-bit, unsigned ints if its exists. More...
 
virtual vector< uint16_t > * getUint16Vector (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to a vector of 16-bit, unsigned ints if its exists. More...
 
virtual vector< uint32_t > * getUint32Vector (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to a vector of 32-bit, unsigned ints if its exists. More...
 
virtual vector< uint64_t > * getUint64Vector (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a pointer to a vector of 64-bit, unsigned ints if its exists. More...
 
virtual uint8_t * getUint8Array (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an array of 8-bit, unsigned ints if its exists. More...
 
virtual uint16_t * getUint16Array (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an array of 16-bit, unsigned ints if its exists. More...
 
virtual uint32_t * getUint32Array (const string &name) const throw (cMsgException)
 This method returns the value of the given field as a array of 32-bit, unsigned ints if its exists. More...
 
virtual uint64_t * getUint64Array (const string &name) const throw (cMsgException)
 This method returns the value of the given field as an array of 64-bit, unsigned ints if its exists. More...
 
virtual void add (const string &name, const char *src, int size, int endian)
 This method adds a named binary field to the compound payload of a message. More...
 
virtual void add (const string &name, const char **srcs, int number, const int sizes[], const int endians[])
 This method adds a named binary field to the compound payload of a message. More...
 
virtual void add (const string &name, const string &s)
 This method adds a string to the compound payload of a message. More...
 
virtual void add (const string &name, const string *s)
 This method adds a string to the compound payload of a message. More...
 
virtual void add (const string &name, const char **strs, int len)
 This method adds an array of strings to the compound payload of a message. More...
 
virtual void add (const string &name, const string *strs, int len)
 This method adds an array of strings to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< string > &strs)
 This method adds a vector of strings to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< string > *strs)
 This method adds a vector of strings to the compound payload of a message. More...
 
virtual void add (const string &name, const cMsgMessage &msg)
 This method adds a cMsg message to the compound payload of a message. More...
 
virtual void add (const string &name, const cMsgMessage *msg)
 This method adds a cMsg message to the compound payload of a message. More...
 
virtual void add (const string &name, const cMsgMessage *msg, int len)
 This method adds an array of cMsg messages to the compound payload of a message. More...
 
virtual void add (const string &name, const cMsgMessage **msg, int len)
 This method adds an array of cMsg messages to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< cMsgMessage > &msgVec)
 This method adds a named vector of cMsgMessage objects to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< cMsgMessage > *msgVec)
 This method adds a named vector of cMsgMessage objects to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< cMsgMessage * > &msgPVec)
 This method adds a named vector of pointers to cMsgMessage objects to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< cMsgMessage * > *msgPVec)
 This method adds a named vector of pointers to cMsgMessage objects to the compound payload of a message. More...
 
virtual void add (const string &name, float val)
 This method adds a named float field to the compound payload of a message. More...
 
virtual void add (const string &name, double val)
 This method adds a named double field to the compound payload of a message. More...
 
virtual void add (const string &name, const float *vals, int len)
 This method adds a named array of floats to the compound payload of a message. More...
 
virtual void add (const string &name, const double *vals, int len)
 This method adds a named array of doubles to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< float > &vals)
 This method adds a named vector of floats to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< float > *vals)
 This method adds a named vector of floats to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< double > &vals)
 This method adds a named vector of doubles to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< double > *vals)
 This method adds a named vector of doubles to the compound payload of a message. More...
 
virtual void add (const string &name, int8_t val)
 This method adds a named, 8-bit, signed int field to the compound payload of a message. More...
 
virtual void add (const string &name, int16_t val)
 This method adds a named, 16-bit, signed int field to the compound payload of a message. More...
 
virtual void add (const string &name, int32_t val)
 This method adds a named, 32-bit, signed int field to the compound payload of a message. More...
 
virtual void add (const string &name, int64_t val)
 This method adds a named, 64-bit, signed int field to the compound payload of a message. More...
 
virtual void add (const string &name, uint8_t val)
 This method adds a named, 8-bit, unsigned int field to the compound payload of a message. More...
 
virtual void add (const string &name, uint16_t val)
 This method adds a named, 16-bit, unsigned int field to the compound payload of a message. More...
 
virtual void add (const string &name, uint32_t val)
 This method adds a named, 32-bit, unsigned int field to the compound payload of a message. More...
 
virtual void add (const string &name, uint64_t val)
 This method adds a named, 64-bit, unsigned int field to the compound payload of a message. More...
 
virtual void add (const string &name, const int8_t *vals, int len)
 This method adds a named array of 8-bit, signed ints to the compound payload of a message. More...
 
virtual void add (const string &name, const int16_t *vals, int len)
 This method adds a named array of 16-bit, signed ints to the compound payload of a message. More...
 
virtual void add (const string &name, const int32_t *vals, int len)
 This method adds a named array of 32-bit, signed ints to the compound payload of a message. More...
 
virtual void add (const string &name, const int64_t *vals, int len)
 This method adds a named array of 64-bit, signed ints to the compound payload of a message. More...
 
virtual void add (const string &name, const uint8_t *vals, int len)
 This method adds a named array of 8-bit, unsigned ints to the compound payload of a message. More...
 
virtual void add (const string &name, const uint16_t *vals, int len)
 This method adds a named array of 16-bit, unsigned ints to the compound payload of a message. More...
 
virtual void add (const string &name, const uint32_t *vals, int len)
 This method adds a named array of 32-bit, unsigned ints to the compound payload of a message. More...
 
virtual void add (const string &name, const uint64_t *vals, int len)
 This method adds a named array of 64-bit, unsigned ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< int8_t > &vals)
 This method adds a named vector of 8-bit, signed ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< int8_t > *vals)
 This method adds a named vector of 8-bit, signed ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< int16_t > &vals)
 This method adds a named vector of 16-bit, signed ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< int16_t > *vals)
 This method adds a named vector of 16-bit, signed ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< int32_t > &vals)
 This method adds a named vector of 32-bit, signed ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< int32_t > *vals)
 This method adds a named vector of 32-bit, signed ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< int64_t > &vals)
 This method adds a named vector of 64-bit, signed ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< int64_t > *vals)
 This method adds a named vector of 64-bit, signed ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< uint8_t > &vals)
 This method adds a named vector of 8-bit, unsigned ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< uint8_t > *vals)
 This method adds a named vector of 8-bit, unsigned ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< uint16_t > &vals)
 This method adds a named vector of 16-bit, unsigned ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< uint16_t > *vals)
 This method adds a named vector of 16-bit, unsigned ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< uint32_t > &vals)
 This method adds a named vector of 32-bit, unsigned ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< uint32_t > *vals)
 This method adds a named vector of 32-bit, unsigned ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< uint64_t > &vals)
 This method adds a named vector of 64-bit, unsigned ints to the compound payload of a message. More...
 
virtual void add (const string &name, const vector< uint64_t > *vals)
 This method adds a named vector of 64-bit, unsigned ints to the compound payload of a message. More...
 

Public Attributes

void * myMsgPointer
 Pointer to C message structure. More...
 

Friends

class cMsg
 Allows cMsg to see myMsgPointer. More...
 

Detailed Description

Class for wrapping cMsg message.

Definition at line 79 of file cMsg.hxx.

Constructor & Destructor Documentation

cMsgMessage::cMsgMessage ( void  )
throw (cMsgException
)

Default constructor creates message.

Exceptions
cMsgException

Definition at line 309 of file cMsgWrapper.cc.

References myMsgPointer.

Referenced by copy(), nullResponse(), and response().

cMsgMessage::cMsgMessage ( const cMsgMessage msg)
throw (cMsgException
)

Copy constructor creates message object from another message object.

Parameters
msgThe other message
Exceptions
cMsgException

Definition at line 327 of file cMsgWrapper.cc.

cMsgMessage::cMsgMessage ( void *  msgPointer)
throw (cMsgException
)

Constructor creates message object from C message pointer.

Parameters
msgPointerC pointer to message
Exceptions
cMsgException

Definition at line 345 of file cMsgWrapper.cc.

cMsgMessage::~cMsgMessage ( void  )
virtual

Destructor frees C message pointer struct.

Definition at line 360 of file cMsgWrapper.cc.

References myMsgPointer.

Member Function Documentation

void cmsg::cMsgMessage::add ( const string &  name,
const char *  src,
int  size,
int  endian 
)
virtual

This method adds a named binary field to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
srcpointer to binary data to add
sizesize in bytes of data to add
endianendian value of binary data, may be CMSG_ENDIAN_BIG, CMSG_ENDIAN_LITTLE, CMSG_ENDIAN_LOCAL, or CMSG_ENDIAN_NOTLOCAL
Exceptions
cMsgExceptionif no memory, error in binary-to-text conversion, name already used, improper name, src is null, size < 1, or endian improper value

Definition at line 1345 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const char **  srcs,
int  number,
const int  sizes[],
const int  endians[] 
)
virtual

This method adds a named binary field to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
srcspointer to array of binary data arrays to add
numbernumber of arrays of binary data to add
sizesarray of sizes in bytes of binary data arrays to add
endiansarray of endian values of binary data arrays, may be CMSG_ENDIAN_BIG, CMSG_ENDIAN_LITTLE, CMSG_ENDIAN_LOCAL, or CMSG_ENDIAN_NOTLOCAL
Exceptions
cMsgExceptionif no memory, error in binary-to-text conversion, name already used, improper name, src is null, size < 1, or endian improper value

Definition at line 1372 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const string &  s 
)
virtual

This method adds a string to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
sstring to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 1400 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const string *  s 
)
virtual

This method adds a string to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
spointer to string to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 1422 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const char **  strs,
int  len 
)
virtual

This method adds an array of strings to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
strsarray of C-style strings to add
lennumber of strings from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, strs is null, len < 1

Definition at line 1439 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const string *  strs,
int  len 
)
virtual

This method adds an array of strings to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
strsarray of strings to add
lennumber of strings from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, strs is null, len < 1

Definition at line 1465 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< string > &  strs 
)
virtual

This method adds a vector of strings to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
strsvector of strings to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 1505 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< string > *  strs 
)
virtual

This method adds a vector of strings to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
strspointer to vector of strings to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 1540 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const cMsgMessage msg 
)
virtual

This method adds a cMsg message to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
msgcMsgMessage object to add
Exceptions
cMsgExceptionif no memory, name already used, improper name

Definition at line 1558 of file cMsgPayload.cc.

References myMsgPointer.

void cmsg::cMsgMessage::add ( const string &  name,
const cMsgMessage msg 
)
virtual

This method adds a cMsg message to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
msgpointer to cMsgMessage object to add
Exceptions
cMsgExceptionif no memory, name already used, improper name

Definition at line 1580 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const cMsgMessage msg,
int  len 
)
virtual

This method adds an array of cMsg messages to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
msgarray of cMsgMessage objects to add
lennumber of objects from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, msg is null, len < 1

Definition at line 1598 of file cMsgPayload.cc.

References myMsgPointer.

void cmsg::cMsgMessage::add ( const string &  name,
const cMsgMessage **  msg,
int  len 
)
virtual

This method adds an array of cMsg messages to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
msgarray of pointers to cMsgMessage objects to add
lennumber of objects from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, msg is null, len < 1

Definition at line 1641 of file cMsgPayload.cc.

References myMsgPointer.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< cMsgMessage > &  msgVec 
)
virtual

This method adds a named vector of cMsgMessage objects to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
msgVecvector of cMsgMessage objects to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, improper name

Definition at line 1723 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< cMsgMessage > *  msgVec 
)
virtual

This method adds a named vector of cMsgMessage objects to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
msgVecpointer to vector of cMsgMessage objects to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, improper name

Definition at line 1781 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< cMsgMessage * > &  msgPVec 
)
virtual

This method adds a named vector of pointers to cMsgMessage objects to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
msgPVecvector of pointers to cMsgMessage to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, improper name

Definition at line 1683 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< cMsgMessage * > *  msgPVec 
)
virtual

This method adds a named vector of pointers to cMsgMessage objects to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
msgPVecpointer to vector of pointers to cMsgMessage to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, improper name

Definition at line 1763 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
float  val 
)
virtual

This method adds a named float field to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valvalue of float to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 1800 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
double  val 
)
virtual

This method adds a named double field to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valvalue of double to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 1823 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const float *  vals,
int  len 
)
virtual

This method adds a named array of floats to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsarray of floats to add (copy)
lennumber of floats from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, or vals is null

Definition at line 1849 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const double *  vals,
int  len 
)
virtual

This method adds a named array of doubles to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsarray of doubles to add (copy)
lennumber of doubles from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, or vals is null

Definition at line 1912 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< float > &  vals 
)
virtual

This method adds a named vector of floats to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsvector of floats to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 1872 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< float > *  vals 
)
virtual

This method adds a named vector of floats to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valspointer to vector of floats to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 1895 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< double > &  vals 
)
virtual

This method adds a named vector of doubles to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsvector of doubles to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 1935 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< double > *  vals 
)
virtual

This method adds a named vector of doubles to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valspointer to vector of doubles to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 1958 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
int8_t  val 
)
virtual

This method adds a named, 8-bit, signed int field to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valvalue of 8-bit, signed int to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 1976 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
int16_t  val 
)
virtual

This method adds a named, 16-bit, signed int field to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valvalue of 16-bit, signed int to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 1999 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
int32_t  val 
)
virtual

This method adds a named, 32-bit, signed int field to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valvalue of 32-bit, signed int to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2022 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
int64_t  val 
)
virtual

This method adds a named, 64-bit, signed int field to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valvalue of 64-bit, signed int to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2045 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
uint8_t  val 
)
virtual

This method adds a named, 8-bit, unsigned int field to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valvalue of 8-bit, unsigned int to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2068 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
uint16_t  val 
)
virtual

This method adds a named, 16-bit, unsigned int field to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valvalue of 16-bit, unsigned int to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2091 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
uint32_t  val 
)
virtual

This method adds a named, 32-bit, unsigned int field to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valvalue of 32-bit, unsigned int to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2114 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
uint64_t  val 
)
virtual

This method adds a named, 64-bit, unsigned int field to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valvalue of 64-bit, unsigned int to add
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2137 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const int8_t *  vals,
int  len 
)
virtual

This method adds a named array of 8-bit, signed ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsarray of 8-bit, signed ints to add (copy)
lennumber of ints from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, or vals is null

Definition at line 2163 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const int16_t *  vals,
int  len 
)
virtual

This method adds a named array of 16-bit, signed ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsarray of 16-bit, signed ints to add (copy)
lennumber of ints from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, or vals is null

Definition at line 2229 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const int32_t *  vals,
int  len 
)
virtual

This method adds a named array of 32-bit, signed ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsarray of 32-bit, signed ints to add (copy)
lennumber of ints from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, or vals is null

Definition at line 2294 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const int64_t *  vals,
int  len 
)
virtual

This method adds a named array of 64-bit, signed ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsarray of 64-bit, signed ints to add (copy)
lennumber of ints from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, or vals is null

Definition at line 2360 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const uint8_t *  vals,
int  len 
)
virtual

This method adds a named array of 8-bit, unsigned ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsarray of 8-bit, unsigned ints to add (copy)
lennumber of ints from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, or vals is null

Definition at line 2427 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const uint16_t *  vals,
int  len 
)
virtual

This method adds a named array of 16-bit, unsigned ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsarray of 16-bit, unsigned ints to add (copy)
lennumber of ints from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, or vals is null

Definition at line 2493 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const uint32_t *  vals,
int  len 
)
virtual

This method adds a named array of 32-bit, unsigned ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsarray of 32-bit, unsigned ints to add (copy)
lennumber of ints from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, or vals is null

Definition at line 2559 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const uint64_t *  vals,
int  len 
)
virtual

This method adds a named array of 64-bit, unsigned ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsarray of 64-bit, unsigned ints to add (copy)
lennumber of ints from array to add
Exceptions
cMsgExceptionif no memory, name already used, improper name, or vals is null

Definition at line 2625 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< int8_t > &  vals 
)
virtual

This method adds a named vector of 8-bit, signed ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsvector of 8-bit, signed ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2186 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< int8_t > *  vals 
)
virtual

This method adds a named vector of 8-bit, signed ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valspointer to vector of 8-bit, signed ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2212 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< int16_t > &  vals 
)
virtual

This method adds a named vector of 16-bit, signed ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsvector of 16-bit, signed ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2252 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< int16_t > *  vals 
)
virtual

This method adds a named vector of 16-bit, signed ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valspointer to vector of 16-bit, signed ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2277 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< int32_t > &  vals 
)
virtual

This method adds a named vector of 32-bit, signed ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsvector of 32-bit, signed ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2317 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< int32_t > *  vals 
)
virtual

This method adds a named vector of 32-bit, signed ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valspointer to vector of 32-bit, signed ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2343 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< int64_t > &  vals 
)
virtual

This method adds a named vector of 64-bit, signed ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsvector of 64-bit, signed ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2383 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< int64_t > *  vals 
)
virtual

This method adds a named vector of 64-bit, signed ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valspointer to vector of 64-bit, signed ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2409 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< uint8_t > &  vals 
)
virtual

This method adds a named vector of 8-bit, unsigned ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsvector of 8-bit, unsigned ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2450 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< uint8_t > *  vals 
)
virtual

This method adds a named vector of 8-bit, unsigned ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valspointer to vector of 8-bit, unsigned ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2476 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< uint16_t > &  vals 
)
virtual

This method adds a named vector of 16-bit, unsigned ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsvector of 16-bit, unsigned ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2516 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< uint16_t > *  vals 
)
virtual

This method adds a named vector of 16-bit, unsigned ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valspointer to vector of 16-bit, unsigned ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2542 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< uint32_t > &  vals 
)
virtual

This method adds a named vector of 32-bit, unsigned ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsvector of 32-bit, unsigned ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2582 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< uint32_t > *  vals 
)
virtual

This method adds a named vector of 32-bit, unsigned ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valspointer to vector of 32-bit, unsigned ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2608 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< uint64_t > &  vals 
)
virtual

This method adds a named vector of 64-bit, unsigned ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valsvector of 64-bit, unsigned ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2648 of file cMsgPayload.cc.

void cmsg::cMsgMessage::add ( const string &  name,
const vector< uint64_t > *  vals 
)
virtual

This method adds a named vector of 64-bit, unsigned ints to the compound payload of a message.

Names may not begin with "cmsg" (case insensitive), be longer than CMSG_PAYLOAD_NAME_LEN, or contain white space or quotes.

Parameters
namename of field to add
valspointer to vector of 64-bit, unsigned ints to add (copy)
Exceptions
cMsgExceptionif no memory, name already used, or improper name

Definition at line 2674 of file cMsgPayload.cc.

cMsgMessage * cMsgMessage::copy ( void  ) const
throw (cMsgException
)
virtual

Copies a message.

Returns
Copy of message

Definition at line 821 of file cMsgWrapper.cc.

References cMsgMessage(), and myMsgPointer.

void cmsg::cMsgMessage::getBinary ( const string &  name,
const char **  val,
int &  len,
int &  endian 
) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a binary array if it exists.

Parameters
namename of field to get
valaddress of pointer to data which sets the pointer to binary
lenint reference which gets set to the number of bytes in binary array
endianint reference which gets set to endian of data (CMSG_ENDIAN_BIG/LITTLE)
Exceptions
cMsgExceptionif no payload/field exists or field is not right type, or if any arg is NULL

Definition at line 312 of file cMsgPayload.cc.

void cmsg::cMsgMessage::getBinaryArray ( const string &  name,
const char ***  vals,
int **  lens,
int **  endians,
int &  count 
) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a binary array if it exists.

Parameters
namename of field to get
valsaddress of array of binary arrays which sets the array pointer
lenspointer to array filled with the number of bytes in each binary array
endianspointer to array filled in with the endianness of data (CMSG_ENDIAN_BIG/LITTLE) in each binary array
countint reference which gets set to number of binary arrays returned
Exceptions
cMsgExceptionif no payload/field exists or field is not right type, or if any arg is NULL

Definition at line 335 of file cMsgPayload.cc.

char * cMsgMessage::getByteArray ( void  )
virtual

Gets byte array.

Returns
Byte array

Definition at line 638 of file cMsgWrapper.cc.

References myMsgPointer.

int cMsgMessage::getByteArrayEndian ( void  )
virtual

Gets endian-ness of message byte array.

Valid return values are:

  • CMSG_ENDIAN_BIG
  • CMSG_ENDIAN_LITTLE
Returns
Endian-ness value

Definition at line 659 of file cMsgWrapper.cc.

References myMsgPointer.

int cMsgMessage::getByteArrayLength ( void  )
virtual

Gets message region-of-interest byte array length.

Returns
Length of array region-of-interest in bytes

Definition at line 535 of file cMsgWrapper.cc.

References myMsgPointer.

int cMsgMessage::getByteArrayLengthFull ( void  )
virtual

Gets message full byte array length.

Returns
Full array length in bytes

Definition at line 551 of file cMsgWrapper.cc.

References myMsgPointer.

int cMsgMessage::getByteArrayOffset ( void  )
virtual

Gets offset in byte array.

Returns
Offset in byte array

Definition at line 584 of file cMsgWrapper.cc.

References myMsgPointer.

string cMsgMessage::getDomain ( void  ) const
throw (cMsgException
)
virtual

Gets message domain.

Returns
Domain
Exceptions
cMsgException

Definition at line 837 of file cMsgWrapper.cc.

References myMsgPointer.

double cmsg::cMsgMessage::getDouble ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a double if its exists.

Parameters
namename of field to get
Returns
field's value as a double
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 607 of file cMsgPayload.cc.

double * cmsg::cMsgMessage::getDoubleArray ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an array of doubles if its exists.

The array must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as array of doubles
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 714 of file cMsgPayload.cc.

vector< double > * cmsg::cMsgMessage::getDoubleVector ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to a vector of doubles if its exists.

The vector pointer must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as vector of doubles
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 686 of file cMsgPayload.cc.

float cmsg::cMsgMessage::getFloat ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a float if its exists.

Parameters
namename of field to get
Returns
field's value as a float
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 588 of file cMsgPayload.cc.

float * cmsg::cMsgMessage::getFloatArray ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to an array of floats if its exists.

The vector pointer must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as array of floats
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 658 of file cMsgPayload.cc.

vector< float > * cmsg::cMsgMessage::getFloatVector ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to a vector of floats if its exists.

The vector pointer must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as vector of floats
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 631 of file cMsgPayload.cc.

int16_t cmsg::cMsgMessage::getInt16 ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an 16 bit, signed integer if its exists.

Parameters
namename of field to get
Returns
field's value as an 16-bit, signed integer
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 760 of file cMsgPayload.cc.

int16_t * cmsg::cMsgMessage::getInt16Array ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an array of 16-bit, signed ints if its exists.

The array must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as array of 16 bit, signed ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 978 of file cMsgPayload.cc.

vector< int16_t > * cmsg::cMsgMessage::getInt16Vector ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to a vector of 16-bit, signed ints if its exists.

The vector pointer must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as vector of 16 bit, signed ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 951 of file cMsgPayload.cc.

int32_t cmsg::cMsgMessage::getInt32 ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an 32 bit, signed integer if its exists.

Parameters
namename of field to get
Returns
field's value as an 32-bit, signed integer
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 779 of file cMsgPayload.cc.

int32_t * cmsg::cMsgMessage::getInt32Array ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an array of 32-bit, signed ints if its exists.

The array must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as array of 32 bit, signed ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 1032 of file cMsgPayload.cc.

vector< int32_t > * cmsg::cMsgMessage::getInt32Vector ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to a vector of 32-bit, signed ints if its exists.

The vector pointer must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as vector of 32 bit, signed ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 1005 of file cMsgPayload.cc.

int64_t cmsg::cMsgMessage::getInt64 ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an 64 bit, signed integer if its exists.

Parameters
namename of field to get
Returns
field's value as an 64-bit, signed integer
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 798 of file cMsgPayload.cc.

int64_t * cmsg::cMsgMessage::getInt64Array ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an array of 64-bit, signed ints if its exists.

The array must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as array of 64 bit, signed ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 1086 of file cMsgPayload.cc.

vector< int64_t > * cmsg::cMsgMessage::getInt64Vector ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to a vector of 64-bit, signed ints if its exists.

The vector pointer must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as vector of 64 bit, signed ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 1059 of file cMsgPayload.cc.

int8_t cmsg::cMsgMessage::getInt8 ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an 8 bit, signed integer if its exists.

Parameters
namename of field to get
Returns
field's value as an 8-bit, signed integer
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 741 of file cMsgPayload.cc.

int8_t * cmsg::cMsgMessage::getInt8Array ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an array of 8-bit, signed ints if its exists.

The array must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as vector of 8 bit, signed ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 924 of file cMsgPayload.cc.

vector< int8_t > * cmsg::cMsgMessage::getInt8Vector ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to a vector of 8-bit, signed ints if its exists.

The vector pointer must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as vector of 8 bit, signed ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 897 of file cMsgPayload.cc.

cMsgMessage * cmsg::cMsgMessage::getMessage ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a cMsgMessage object pointer if its exists.

A copy of the message is made, so the pointer must be deleted to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as cMsg message
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 359 of file cMsgPayload.cc.

cMsgMessage * cmsg::cMsgMessage::getMessageArray ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to an array of cMsgMessage objects, if it exists.

The array must be deleted by caller to avoid a memory leak, as do all the messages it contains.

Parameters
namename of field to get
Returns
field's value as array of cMsgMessage objects
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 481 of file cMsgPayload.cc.

cMsgMessage ** cmsg::cMsgMessage::getMessagePArray ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to an array of pointers to cMsgMessage objects, if it exists.

The array must be deleted by caller to avoid a memory leak, as do all the messages it contains.

Parameters
namename of field to get
Returns
field's value as array of pointers to cMsgMessage objects
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 451 of file cMsgPayload.cc.

vector< cMsgMessage * > * cmsg::cMsgMessage::getMessagePVector ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to a vector of pointers to cMsgMessage objects, if its exists.

The vector pointer must be deleted by caller to avoid a memory leak, as do all the messages it contains.

Parameters
namename of field to get
Returns
field's value as vector of pointers to cMsgMessage objects
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 389 of file cMsgPayload.cc.

vector< cMsgMessage > * cmsg::cMsgMessage::getMessageVector ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to a vector of cMsgMessage objects, if its exists.

The vector pointer must be deleted by caller to avoid a memory leak, as do all the messages it contains.

Parameters
namename of field to get
Returns
field's value as vector of cMsgMessage objects
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 420 of file cMsgPayload.cc.

string cMsgMessage::getReceiver ( void  ) const
throw (cMsgException
)
virtual

Gets message receiver.

Returns
Receiver
Exceptions
cMsgException

Definition at line 863 of file cMsgWrapper.cc.

References myMsgPointer.

string cMsgMessage::getReceiverHost ( void  ) const
throw (cMsgException
)
virtual

Gets message receiver host.

Returns
Receiver host
Exceptions
cMsgException

Definition at line 889 of file cMsgWrapper.cc.

References myMsgPointer.

struct timespec cMsgMessage::getReceiverTime ( void  ) const
throw (cMsgException
)
virtual

Gets message receiver time.

Returns
Receiver time
Exceptions
cMsgException

Definition at line 967 of file cMsgWrapper.cc.

bool cMsgMessage::getReliableSend ( void  ) const
throw (cMsgException
)
virtual

True if message sent via reliable send.

Returns
True if reliable send used
Exceptions
cMsgException

Definition at line 1378 of file cMsgWrapper.cc.

References myMsgPointer.

string cMsgMessage::getSender ( void  ) const
throw (cMsgException
)
virtual

Gets message sender.

Returns
Sender
Exceptions
cMsgException

Definition at line 915 of file cMsgWrapper.cc.

References myMsgPointer.

string cMsgMessage::getSenderHost ( void  ) const
throw (cMsgException
)
virtual

Gets message sender host.

Returns
Sender host
Exceptions
cMsgException

Definition at line 941 of file cMsgWrapper.cc.

References myMsgPointer.

struct timespec cMsgMessage::getSenderTime ( void  ) const
throw (cMsgException
)
virtual

Gets message sender time.

Returns
Sender time
Exceptions
cMsgException

Definition at line 988 of file cMsgWrapper.cc.

string cmsg::cMsgMessage::getString ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a string if its exists.

Parameters
namename of field to get
Returns
field's value as string
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 509 of file cMsgPayload.cc.

string * cmsg::cMsgMessage::getStringArray ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to an array of strings if its exists.

The array must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as vector of strings
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 561 of file cMsgPayload.cc.

vector< string > * cmsg::cMsgMessage::getStringVector ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to a vector of strings if its exists.

The vector must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as vector of strings
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 533 of file cMsgPayload.cc.

string cMsgMessage::getSubject ( void  ) const
throw (cMsgException
)
virtual

Gets message subject.

Returns
Message subject
Exceptions
cMsgException

Definition at line 374 of file cMsgWrapper.cc.

References myMsgPointer.

int cMsgMessage::getSubscriptionCueSize ( void  ) const
throw (cMsgException
)
virtual

Gets current subscription cue size.

Returns
Current cue size
Exceptions
cMsgException

Definition at line 1357 of file cMsgWrapper.cc.

References myMsgPointer.

string cMsgMessage::getSubscriptionDomain ( void  ) const
throw (cMsgException
)
virtual

Gets subscription domain.

Returns
Subscription domain
Exceptions
cMsgException

Definition at line 1253 of file cMsgWrapper.cc.

References myMsgPointer.

string cMsgMessage::getSubscriptionSubject ( void  ) const
throw (cMsgException
)
virtual

Gets subscription subject.

Returns
Subscription subject
Exceptions
cMsgException

Definition at line 1279 of file cMsgWrapper.cc.

References myMsgPointer.

string cMsgMessage::getSubscriptionType ( void  ) const
throw (cMsgException
)
virtual

Gets subscription type.

Returns
Subscription type
Exceptions
cMsgException

Definition at line 1305 of file cMsgWrapper.cc.

References myMsgPointer.

string cMsgMessage::getSubscriptionUDL ( void  ) const
throw (cMsgException
)
virtual

Gets subscription UDL.

Returns
Subscription UDL
Exceptions
cMsgException

Definition at line 1331 of file cMsgWrapper.cc.

References myMsgPointer.

string cMsgMessage::getText ( void  ) const
throw (cMsgException
)
virtual

Gets message text.

Returns
Message text
Exceptions
cMsgException

Definition at line 462 of file cMsgWrapper.cc.

References myMsgPointer.

string cMsgMessage::getType ( void  ) const
throw (cMsgException
)
virtual

Gets message type.

Returns
Message type
Exceptions
cMsgException

Definition at line 418 of file cMsgWrapper.cc.

References myMsgPointer.

uint16_t cmsg::cMsgMessage::getUint16 ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an 16 bit, unsigned integer if its exists.

Parameters
namename of field to get
Returns
field's value as an 16-bit, unsigned integer
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 836 of file cMsgPayload.cc.

uint16_t * cmsg::cMsgMessage::getUint16Array ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an array of 16-bit, unsigned ints if its exists.

The array must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as array of 16 bit, unsigned ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 1198 of file cMsgPayload.cc.

vector< uint16_t > * cmsg::cMsgMessage::getUint16Vector ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to a vector of 16-bit, unsigned ints if its exists.

The vector pointer must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as vector of 16 bit, unsigned ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 1170 of file cMsgPayload.cc.

uint32_t cmsg::cMsgMessage::getUint32 ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an 32 bit, unsigned integer if its exists.

Parameters
namename of field to get
Returns
field's value as an 32-bit, unsigned integer
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 855 of file cMsgPayload.cc.

uint32_t * cmsg::cMsgMessage::getUint32Array ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a array of 32-bit, unsigned ints if its exists.

The array must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as array of 32 bit, unsigned ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 1252 of file cMsgPayload.cc.

vector< uint32_t > * cmsg::cMsgMessage::getUint32Vector ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to a vector of 32-bit, unsigned ints if its exists.

The vector pointer must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as vector of 32 bit, unsigned ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 1225 of file cMsgPayload.cc.

uint64_t cmsg::cMsgMessage::getUint64 ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an 64 bit, unsigned integer if its exists.

Parameters
namename of field to get
Returns
field's value as an 64-bit, unsigned integer
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 874 of file cMsgPayload.cc.

uint64_t * cmsg::cMsgMessage::getUint64Array ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an array of 64-bit, unsigned ints if its exists.

The array must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as array of 64 bit, unsigned ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 1307 of file cMsgPayload.cc.

vector< uint64_t > * cmsg::cMsgMessage::getUint64Vector ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to a vector of 64-bit, unsigned ints if its exists.

The vector pointer must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as vector of 64 bit, unsigned ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 1279 of file cMsgPayload.cc.

uint8_t cmsg::cMsgMessage::getUint8 ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an 8 bit, unsigned integer if its exists.

Parameters
namename of field to get
Returns
field's value as an 8-bit, unsigned integer
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 817 of file cMsgPayload.cc.

uint8_t * cmsg::cMsgMessage::getUint8Array ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as an array of 8-bit, unsigned ints if its exists.

The array must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as array of 8 bit, unsigned ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 1142 of file cMsgPayload.cc.

vector< uint8_t > * cmsg::cMsgMessage::getUint8Vector ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the value of the given field as a pointer to a vector of 8-bit, unsigned ints if its exists.

The vector pointer must be deleted by caller to avoid a memory leak.

Parameters
namename of field to get
Returns
field's value as vector of 8 bit, unsigned ints
Exceptions
cMsgExceptionif no payload/field exists or field is not right type

Definition at line 1114 of file cMsgPayload.cc.

int cMsgMessage::getUserInt ( void  ) const
throw (cMsgException
)
virtual

Gets message user int.

Returns
User int
Exceptions
cMsgException

Definition at line 725 of file cMsgWrapper.cc.

References myMsgPointer.

struct timespec cMsgMessage::getUserTime ( void  ) const
throw (cMsgException
)
virtual

Gets message user time.

Returns
Timespec holding user time
Exceptions
cMsgException

Definition at line 764 of file cMsgWrapper.cc.

int cMsgMessage::getVersion ( void  ) const
throw (cMsgException
)
virtual

Gets cMsg version.

Returns
Version

Definition at line 801 of file cMsgWrapper.cc.

References myMsgPointer.

bool cmsg::cMsgMessage::hasPayload ( ) const
virtual

This method returns whether a message has a compound payload or not.

Returns
true if message has a payload, else false

Definition at line 76 of file cMsgPayload.cc.

bool cMsgMessage::isGetRequest ( void  ) const
throw (cMsgException
)
virtual

True if message is a get request.

Returns
True if get request

Definition at line 1008 of file cMsgWrapper.cc.

References myMsgPointer.

bool cMsgMessage::isGetResponse ( void  ) const
throw (cMsgException
)
virtual

True if message is a get response.

Returns
True if get response

Definition at line 1028 of file cMsgWrapper.cc.

References myMsgPointer.

bool cMsgMessage::isNullGetResponse ( void  ) const
throw (cMsgException
)
virtual

True if message is a NULL get response.

Returns
True if NULL get response
Exceptions
cMsgException

Definition at line 1049 of file cMsgWrapper.cc.

References myMsgPointer.

void cMsgMessage::makeNullResponse ( const cMsgMessage msg)
throw (cMsgException
)
virtual

Makes a message a null response message.

Parameters
msgMessage to make a null response
Exceptions
cMsgException

Definition at line 1070 of file cMsgWrapper.cc.

void cMsgMessage::makeNullResponse ( const cMsgMessage msg)
throw (cMsgException
)
virtual

Makes a message a null response message.

Parameters
msgMessage to make a null response
Exceptions
cMsgException

Definition at line 1090 of file cMsgWrapper.cc.

void cMsgMessage::makeResponse ( const cMsgMessage msg)
throw (cMsgException
)
virtual

Makes a message a response message.

Parameters
msgMessage to make a response
Exceptions
cMsgException

Definition at line 1110 of file cMsgWrapper.cc.

void cMsgMessage::makeResponse ( const cMsgMessage msg)
throw (cMsgException
)
virtual

Makes a message a response message.

Parameters
msgMessage to make a response
Exceptions
cMsgException

Definition at line 1130 of file cMsgWrapper.cc.

bool cMsgMessage::needToSwap ( void  ) const
throw (cMsgException
)
virtual

True if need to swap byte array.

Returns
True if must swap
Exceptions
cMsgException

Definition at line 704 of file cMsgWrapper.cc.

References myMsgPointer.

cMsgMessage * cMsgMessage::nullResponse ( void  ) const
throw (cMsgException
)
virtual

Creates a null response message.

Returns
Null response message
Exceptions
cMsgException

Definition at line 1150 of file cMsgWrapper.cc.

References cMsgMessage(), and myMsgPointer.

void cmsg::cMsgMessage::payloadClear ( void  )
virtual

This method removes all the user-added items in the payload.

The payload may still contain fields added by the cMsg system.

Definition at line 44 of file cMsgPayload.cc.

bool cmsg::cMsgMessage::payloadContainsName ( const string &  name) const
virtual

This method returns whether an item in the payload has the given name or not.

Parameters
namename of field to look for
Returns
true if an item in the payload has the given name, else false

Definition at line 90 of file cMsgPayload.cc.

void cmsg::cMsgMessage::payloadCopy ( const cMsgMessage msg)
throw (cMsgException
)
virtual

This method copies the payload from another message.

The original payload is overwritten.

Parameters
msgreference to message to copy payload from
Exceptions
cMsgExceptionif no memory

Definition at line 170 of file cMsgPayload.cc.

map< string, int > * cmsg::cMsgMessage::payloadGet ( ) const
throw (cMsgException
)
virtual

This method returns a pointer to a map containing all name/type pairs of the payload.

A field's name is the key and type is the value. The map must be deleted to avoid a memory leak.

Returns
a pointer to a map containing all name/type pairs of the payload
Exceptions
cMsgExceptionif no payload exists, or if name is NULL

Definition at line 240 of file cMsgPayload.cc.

int cmsg::cMsgMessage::payloadGetCount ( ) const
virtual

This method returns the number of payload items a message has.

Returns
number of payload items a message has

Definition at line 101 of file cMsgPayload.cc.

string cmsg::cMsgMessage::payloadGetFieldDescription ( const string &  name) const
throw (cMsgException
)
virtual

This method returns a description of the given field name in the payload.

Returns
field description string
Exceptions
cMsgExceptionif no such field in the payload

Definition at line 218 of file cMsgPayload.cc.

string cmsg::cMsgMessage::payloadGetText ( ) const
virtual

This method returns a text representation of the payload.

Its format is proprietary - not XML.

Returns
payload representation string

Definition at line 185 of file cMsgPayload.cc.

int cmsg::cMsgMessage::payloadGetType ( const string &  name) const
throw (cMsgException
)
virtual

This method returns the type of data associated with the payload field given by the name argument.

The returned type may have the following values:

  • CMSG_CP_STR for a String
  • CMSG_CP_FLT for a 4 byte float
  • CMSG_CP_DBL for an 8 byte float
  • CMSG_CP_INT8 for an 8 bit int
  • CMSG_CP_INT16 for a 16 bit int
  • CMSG_CP_INT32 for a 32 bit int
  • CMSG_CP_INT64 for a 64 bit int
  • CMSG_CP_UINT8 for an unsigned 8 bit int
  • CMSG_CP_UINT16 for an unsigned 16 bit int
  • CMSG_CP_UINT32 for an unsigned 32 bit int
  • CMSG_CP_UINT64 for an unsigned 64 bit int
  • CMSG_CP_MSG for a cMsg message
  • CMSG_CP_BIN for binary

  • CMSG_CP_STR_A for a String array
  • CMSG_CP_FLT_A for a 4 byte float array
  • CMSG_CP_DBL_A for an 8 byte float array
  • CMSG_CP_INT8_A for an 8 bit int array
  • CMSG_CP_INT16_A for a 16 bit int array
  • CMSG_CP_INT32_A for a 32 bit int array
  • CMSG_CP_INT64_A for a 64 bit int array
  • CMSG_CP_UINT8_A for an unsigned 8 bit int array
  • CMSG_CP_UINT16_A for an unsigned 16 bit int array
  • CMSG_CP_UINT32_A for an unsigned 32 bit int array
  • CMSG_CP_UINT64_A for an unsigned 64 bit int array
  • CMSG_CP_MSG_A for a cMsg message array
Parameters
namename of field to find type for
Returns
the type of data associated with the payload field given by the name argument
Exceptions
cMsgExceptionif no payload/field exists, or if name is NULL

Definition at line 148 of file cMsgPayload.cc.

void cmsg::cMsgMessage::payloadPrint ( void  ) const
virtual

This method prints out the message payload in a readable form.

Definition at line 65 of file cMsgPayload.cc.

bool cmsg::cMsgMessage::payloadRemoveField ( const string &  name)
virtual

This method removes the named field if its exists.

Parameters
namename of field to remove
Returns
true if successful
false if no field with that name was found

Definition at line 271 of file cMsgPayload.cc.

void cmsg::cMsgMessage::payloadReset ( void  )
virtual

This method removes all items (including those added by the cMsg system) in the payload.

This method frees the allocated memory of the given message's entire payload and then initializes the payload components of the message.

Definition at line 56 of file cMsgPayload.cc.

void cmsg::cMsgMessage::payloadSetFromText ( const string &  txt)
throw (cMsgException
)
virtual

This method takes a string returned from payloadGetText as an argument and constructs a payload out of it.

Any existing payload is overwritten.

Parameters
txtstring representing payload

Definition at line 201 of file cMsgPayload.cc.

void cMsgMessage::resetByteArrayLength ( )
virtual

Sets message region-of-interest byte array length to the full length of the array.

Definition at line 522 of file cMsgWrapper.cc.

References myMsgPointer.

cMsgMessage * cMsgMessage::response ( void  ) const
throw (cMsgException
)
virtual

Creates a response message.

Returns
Response message
Exceptions
cMsgException

Definition at line 1170 of file cMsgWrapper.cc.

References cMsgMessage(), and myMsgPointer.

void cMsgMessage::setByteArray ( char *  array,
int  length 
)
throw (cMsgException
)
virtual

Specifies byte array by copying it.

Parameters
arrayByte array
lengthLength of byte array in bytes
Exceptions
cMsgException

Definition at line 602 of file cMsgWrapper.cc.

void cMsgMessage::setByteArrayEndian ( int  endian)
throw (cMsgException
)
virtual

Sets endian-ness of message byte array.

Valid values are:

  • ENDIAN_BIG
  • ENDIAN_LITTLE
  • ENDIAN_LOCAL
  • ENDIAN_NOTLOCAL
  • ENDIAN_SWITCH
Parameters
endianEndian-ness value
Exceptions
cMsgException

Definition at line 684 of file cMsgWrapper.cc.

void cMsgMessage::setByteArrayLength ( int  length)
throw (cMsgException
)
virtual

Sets message region-of-interest byte array length.

Parameters
lengthArray length in bytes
Exceptions
cMsgException

Definition at line 506 of file cMsgWrapper.cc.

void cMsgMessage::setByteArrayNoCopy ( char *  array,
int  length 
)
throw (cMsgException
)
virtual

Specifies the byte array by only copying the pointer to the array.

Parameters
arrayByte array
lengthLength of byte array in bytes
Exceptions
cMsgException

Definition at line 621 of file cMsgWrapper.cc.

void cMsgMessage::setByteArrayOffset ( int  offset)
throw (cMsgException
)
virtual

Specifies offset in byte array.

Parameters
offsetOffset in byte array
Exceptions
cMsgException

Definition at line 567 of file cMsgWrapper.cc.

void cMsgMessage::setGetResponse ( bool  b)
throw (cMsgException
)
virtual

Makes message a get response message.

Parameters
bTrue to make message a get response message
Exceptions
cMsgException

Definition at line 1190 of file cMsgWrapper.cc.

void cmsg::cMsgMessage::setHistoryLengthMax ( int  len) const
throw (cMsgException
)
virtual

This method sets the maximum number of entries this message keeps of its history of various parameters (sender's name, host, time).

Parameters
lenmax number of entries this message keeps of its history of various parameters
Exceptions
cMsgExceptionif len < 0 or > CMSG_HISTORY_LENGTH_ABS_MAX

Definition at line 287 of file cMsgPayload.cc.

void cMsgMessage::setNullGetResponse ( bool  b)
throw (cMsgException
)
virtual

Makes message a null response message.

Parameters
bTrue to make message a null response message
Exceptions
cMsgException

Definition at line 1208 of file cMsgWrapper.cc.

void cMsgMessage::setReliableSend ( bool  b)
throw (cMsgException
)
virtual

Sets message reliable send flag.

Parameters
bTrue if reliable send should be used
Exceptions
cMsgException

Definition at line 1399 of file cMsgWrapper.cc.

void cMsgMessage::setSubject ( const string &  subject)
throw (cMsgException
)
virtual

Sets message subject.

Parameters
subjectMessage subject
Exceptions
cMsgException

Definition at line 400 of file cMsgWrapper.cc.

void cMsgMessage::setText ( const string &  text)
throw (cMsgException
)
virtual

Sets message text.

Parameters
textMessage text
Exceptions
cMsgException

Definition at line 488 of file cMsgWrapper.cc.

void cMsgMessage::setType ( const string &  type)
throw (cMsgException
)
virtual

Sets message type.

Parameters
typeMessage type
Exceptions
cMsgException

Definition at line 444 of file cMsgWrapper.cc.

void cMsgMessage::setUserInt ( int  i)
throw (cMsgException
)
virtual

Sets message user int.

Parameters
iUser int
Exceptions
cMsgException

Definition at line 746 of file cMsgWrapper.cc.

void cMsgMessage::setUserTime ( const struct timespec &  userTime)
throw (cMsgException
)
virtual

Sets message user time.

Parameters
userTimeTimespec holding user time

Definition at line 784 of file cMsgWrapper.cc.

string cMsgMessage::toString ( void  ) const
throw (cMsgException
)
virtual

Gets xml representation of message.

Returns
xml representation of message
Exceptions
cMsgException

Definition at line 1226 of file cMsgWrapper.cc.

References myMsgPointer.

Friends And Related Function Documentation

friend class cMsg
friend

Allows cMsg to see myMsgPointer.

Definition at line 81 of file cMsg.hxx.

Member Data Documentation


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