makRadarFx::DtHeartbeatMessage Class Reference

Detailed Description

This message is sent periodically between the client and server to ensure that the connection is still active. It contains no payload data and serves only as a keepalive mechanism. Both the client and server can send heartbeat messages, and both should respond to received heartbeat messages to confirm connectivity.

#include <rfxSystemMessage.h>

Inheritance diagram for makRadarFx::DtHeartbeatMessage:

Public Member Functions
	DtHeartbeatMessage ()
virtual	~DtHeartbeatMessage ()
virtual int	messageSize ()
virtual DtBaseMessage *	clone ()
Public Member Functions inherited from makRadarFx::DtBaseMessage
	DtBaseMessage ()
virtual	~DtBaseMessage ()
virtual unsigned int	messageType () const
virtual unsigned char *	encode ()
virtual void	setRequestorId (const std::string &requestor)
virtual std::string	requestorId ()
virtual void	setRequestId (int id)
virtual int	requestId ()

Static Public Member Functions
static DtBaseMessage *	decode (unsigned char *buffer, int length)

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

Additional Inherited Members
Protected Attributes inherited from makRadarFx::DtBaseMessage
unsigned int	myMessageType
std::string	myRequestorId
int	myRequestId

Constructor & Destructor Documentation

DtHeartbeatMessage()

makRadarFx::DtHeartbeatMessage::DtHeartbeatMessage

(

)

Default constructor.

Initializes a new heartbeat message with the appropriate message type

~DtHeartbeatMessage()

virtual makRadarFx::DtHeartbeatMessage::~DtHeartbeatMessage ( )

virtual

Virtual destructor.

Cleans up any resources associated with the heartbeat message

Member Function Documentation

messageSize()

virtual int makRadarFx::DtHeartbeatMessage::messageSize ( )

virtual

Gets the size of the encoded message in bytes.

Returns

Size of the message in bytes when encoded

Heartbeat messages have minimal size since they contain no payload data

Reimplemented from makRadarFx::DtBaseMessage.

decode()

static DtBaseMessage * makRadarFx::DtHeartbeatMessage::decode ( unsigned char * buffer, int length )

static

Decodes a byte array into a message object.

Parameters

buffer	Pointer to the encoded byte array
length	Length of the encoded byte array

Returns

Pointer to the newly created message object

Static decoder function used by the message factory to create message objects from encoded data.

References makRadarFx::DtBaseMessage::DtBaseMessage().

clone()

virtual DtBaseMessage * makRadarFx::DtHeartbeatMessage::clone ( )

virtual

Creates a deep copy of this message.

Returns

Pointer to a new instance that is a copy of this message

Creates a new message instance that is an exact copy of this message. The caller is responsible for managing the memory of the returned object.

Implements makRadarFx::DtBaseMessage.

References makRadarFx::DtBaseMessage::DtBaseMessage().

serialize()

virtual void makRadarFx::DtHeartbeatMessage::serialize ( DtStreamWriter & writer )

protectedvirtual

Serializes the message data to a stream writer.

Parameters

writer

Reference to the stream writer to write the data to

Writes the message data to the provided stream writer. For heartbeat messages, this only writes the base message fields as there is no additional payload data.

Reimplemented from makRadarFx::DtBaseMessage.

deserialize()

virtual void makRadarFx::DtHeartbeatMessage::deserialize ( DtStreamReader & reader )

protectedvirtual

Deserializes message data from a stream reader.

Parameters

reader

Reference to the stream reader to read the data from

Reads the message data from the provided stream reader. For heartbeat messages, this only reads the base message fields as there is no additional payload data.

Reimplemented from makRadarFx::DtBaseMessage.

---

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

• include/vrvExtensions/vreRadarFxShared/rfxSystemMessage.h