Represents a message to be written to/read from a message queue. More...

#include <eqbase.h>

Inheritance diagram for EQueueMessage:

Public Member Functions
	EQueueMessage ()
	Default constructor. More...

	~EQueueMessage ()
	Class destructor. More...

EQueueMessage &	operator= (const EQueueMessage &a)
	Assignment operator. More...

virtual Void	getLength (ULong &length)
	Calculates the length of the message. More...

virtual Void	serialize (pVoid pBuffer, ULong &nOffset)
	Serializes the message. More...

virtual Void	unserialize (pVoid pBuffer, ULong &nOffset)
	Deserializes the message. More...

ETime &	getTimer ()
	Retrieves the message lifetime timer. More...

Void	setMsgType (Long msgType)
	Assigns the message type value. More...

Long	getMsgType ()
	Retrieves the message type value. More...

Public Member Functions inherited from EMessage
	EMessage ()
	Default constructor. More...

	~EMessage ()
	Class destructor. More...

Void	elementLength (Bool val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	elementLength (Char val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	elementLength (UChar val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	elementLength (Short val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	elementLength (UShort val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	elementLength (Long val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	elementLength (ULong val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	elementLength (LongLong val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	elementLength (ULongLong val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	elementLength (Float val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	elementLength (Double val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	elementLength (cpStr val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	elementLength (ETimer &val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	elementLength (ETime &val, ULong &length)
	Adds the length of a Bool value to the message length. More...

Void	pack (Bool val, pVoid pBuffer, ULong &nOffset)
	Packs the Bool value. More...

Void	pack (Char val, pVoid pBuffer, ULong &nOffset)
	Packs the Char value. More...

Void	pack (UChar val, pVoid pBuffer, ULong &nOffset)
	Packs the UChar value. More...

Void	pack (Short val, pVoid pBuffer, ULong &nOffset)
	Packs the Short value. More...

Void	pack (UShort val, pVoid pBuffer, ULong &nOffset)
	Packs the UShort value. More...

Void	pack (Long val, pVoid pBuffer, ULong &nOffset)
	Packs the Long value. More...

Void	pack (ULong val, pVoid pBuffer, ULong &nOffset)
	Packs the ULong value. More...

Void	pack (LongLong val, pVoid pBuffer, ULong &nOffset)
	Packs the LongLong value. More...

Void	pack (ULongLong val, pVoid pBuffer, ULong &nOffset)
	Packs the ULongLong value. More...

Void	pack (Float val, pVoid pBuffer, ULong &nOffset)
	Packs the Float value. More...

Void	pack (Double val, pVoid pBuffer, ULong &nOffset)
	Packs the Double value. More...

Void	pack (cpStr val, pVoid pBuffer, ULong &nOffset)
	Packs the NULL terminated string value. More...

Void	pack (ETimer &val, pVoid pBuffer, ULong &nOffset)
	Packs the Timer value. More...

Void	pack (ETime &val, pVoid pBuffer, ULong &nOffset)
	Packs the Time value. More...

Void	pack (EString &val, pVoid pBuffer, ULong &nOffset)
	Packs the string value. More...

Void	unpack (Bool &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a Bool value. More...

Void	unpack (Char &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a Char value. More...

Void	unpack (UChar &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a UChar value. More...

Void	unpack (Short &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a Short value. More...

Void	unpack (UShort &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a UShort value. More...

Void	unpack (Long &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a Long value. More...

Void	unpack (ULong &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a ULong value. More...

Void	unpack (LongLong &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a LongLong value. More...

Void	unpack (ULongLong &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a ULongLong value. More...

Void	unpack (Float &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a Float value. More...

Void	unpack (Double &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a Double value. More...

Void	unpack (pStr val, pVoid pBuffer, ULong &nOffset)
	Unpacks a NULL terminated string value. More...

Void	unpack (ETimer &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a Timer value. More...

Void	unpack (ETime &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a Time value. More...

Void	unpack (EString &val, pVoid pBuffer, ULong &nOffset)
	Unpacks a string value. More...

Friends
class	EQueueBase

Detailed Description

Represents a message to be written to/read from a message queue.

Constructor & Destructor Documentation

◆ EQueueMessage()

EQueueMessage::EQueueMessage ( )

inline

Default constructor.

◆ ~EQueueMessage()

EQueueMessage::~EQueueMessage ( )

inline

Class destructor.

Member Function Documentation

◆ getLength()

Void EQueueMessage::getLength ( ULong & length )

virtual

Calculates the length of the message.

Parameters

length the variable to update with the length.

Reimplemented from EMessage.

◆ getMsgType()

Long EQueueMessage::getMsgType ( )

inline

Retrieves the message type value.

Returns: the message type value.

◆ getTimer()

ETime& EQueueMessage::getTimer ( )

inline

Retrieves the message lifetime timer.

Returns: a reference to the message lifetime timer.

◆ operator=()

EQueueMessage& EQueueMessage::operator= ( const EQueueMessage & a )

inline

Assignment operator.

Parameters

a	the EQueueMessage to copy.

Returns: a reference to this object.

◆ serialize()

Void EQueueMessage::serialize	(	pVoid	pBuffer,
		ULong &	nOffset
	)

virtual

Serializes the message.

Parameters

pBuffer	a pointer to the serialized message data.
nOffset	a reference that will update the offset where to next write data.

Reimplemented from EMessage.

◆ setMsgType()

Void EQueueMessage::setMsgType ( Long msgType )

inline

Assigns the message type value.

Parameters

msgType the message type value.

◆ unserialize()

Void EQueueMessage::unserialize	(	pVoid	pBuffer,
		ULong &	nOffset
	)

virtual

Deserializes the message.

Parameters

pBuffer	a pointer to the serialized message data.
nOffset	a reference that will update the offset where to next read data.

Reimplemented from EMessage.

Friends And Related Function Documentation

◆ EQueueBase

friend class EQueueBase

friend

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

/home/vagrant/share/code/epctools/include/epc/eqbase.h
/home/vagrant/share/code/epctools/src/eqbase.cpp

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ EQueueMessage()

◆ ~EQueueMessage()

Member Function Documentation

◆ getLength()

◆ getMsgType()

◆ getTimer()

◆ operator=()

◆ serialize()

◆ setMsgType()

◆ unserialize()

Friends And Related Function Documentation

◆ EQueueBase