makVrf::DtBaseMessage Class Reference

DtBaseMessage is the base class for all messages that can be sent between the server and the client. More...

Inheritance diagram for makVrf::DtBaseMessage:

Public Member Functions
	DtBaseMessage ()
	CTOR/DTOR. More...
virtual	~DtBaseMessage ()
virtual unsigned int	messageType () const
	Get the name of the message type. More...
virtual unsigned char *	encode ()
	Encode the message as an array of bytes and return the bytes the receiver is responsible for calling delete [] on these bytes. More...
virtual int	messageSize ()
	this function needs to be in each derived class for decoding More...
virtual DtBaseMessage *	clone ()=0
	clones this message. More...
virtual void	setRequestorId (const std::string &requestor)
	Assigns the requestor name of this message. More...
virtual std::string	requestorId ()
virtual void	setRequestId (int id)
	Assigns the request id of this message. More...
virtual int	requestId ()

Protected Member Functions
virtual void	serialize (DtStreamWriter &writer)
virtual void	deserialize (DtStreamReader &reader)

Protected Attributes
unsigned int	myMessageType
std::string	myRequestorId
int	myRequestId

Detailed Description

DtBaseMessage is the base class for all messages that can be sent between the server and the client.

Constructor & Destructor Documentation

makVrf::DtBaseMessage::DtBaseMessage

(

)

CTOR/DTOR.

virtual makVrf::DtBaseMessage::~DtBaseMessage ( )

virtual

Member Function Documentation

virtual unsigned int makVrf::DtBaseMessage::messageType ( ) const

virtual

Get the name of the message type.

virtual unsigned char* makVrf::DtBaseMessage::encode ( )

virtual

Encode the message as an array of bytes and return the bytes the receiver is responsible for calling delete [] on these bytes.

virtual int makVrf::DtBaseMessage::messageSize ( )

virtual

this function needs to be in each derived class for decoding

Get the size of the message data in bytes

Reimplemented in makVrf::DtTerrainAreaResponse, makVrf::DtNavMeshAreaResponse, makVrf::DtFeatureResponse, makVrf::DtNavMeshAreaRequest, makVrf::DtTerrainAreaRequest, makVrf::DtFeatureRequest, and makVrf::DtHeartbeatMessage.

virtual DtBaseMessage* makVrf::DtBaseMessage::clone ( )

pure virtual

clones this message.

Caller of function is responsible for managing memory

Implemented in makVrf::DtTerrainAreaResponse, makVrf::DtNavMeshAreaResponse, makVrf::DtFeatureResponse, makVrf::DtNavMeshAreaRequest, makVrf::DtTerrainAreaRequest, makVrf::DtFeatureRequest, and makVrf::DtHeartbeatMessage.

virtual void makVrf::DtBaseMessage::setRequestorId ( const std::string &  requestor )

virtual

Assigns the requestor name of this message.

If left at "" (default) then the DtRadarFxConnector's requestor() function is used to generate a name when the message is sent

virtual std::string makVrf::DtBaseMessage::requestorId ( )

virtual

virtual void makVrf::DtBaseMessage::setRequestId ( int  id )

virtual

Assigns the request id of this message.

If left at 0 (default) then the DtRadarFxConnector's nextId() function is used to generate a request id when the message is sent

virtual int makVrf::DtBaseMessage::requestId ( )

virtual

virtual void makVrf::DtBaseMessage::serialize ( DtStreamWriter &  writer )

protectedvirtual

Reimplemented in makVrf::DtTerrainAreaResponse, makVrf::DtTerrainAreaRequest, makVrf::DtNavMeshAreaResponse, makVrf::DtFeatureResponse, makVrf::DtNavMeshAreaRequest, makVrf::DtFeatureRequest, and makVrf::DtHeartbeatMessage.

virtual void makVrf::DtBaseMessage::deserialize ( DtStreamReader &  reader )

protectedvirtual

Reimplemented in makVrf::DtTerrainAreaResponse, makVrf::DtTerrainAreaRequest, makVrf::DtNavMeshAreaResponse, makVrf::DtFeatureResponse, makVrf::DtNavMeshAreaRequest, makVrf::DtFeatureRequest, and makVrf::DtHeartbeatMessage.

Member Data Documentation

unsigned int makVrf::DtBaseMessage::myMessageType

protected

std::string makVrf::DtBaseMessage::myRequestorId

protected

int makVrf::DtBaseMessage::myRequestId

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-8-branch/include/vrfDebugDrawConnector/vrfMessage.h