DtSplitMessageHandle Class Reference

A DtSplitMessageHandle. More...

List of all members.

Public Member Functions
	DtSplitMessageHandle ()
	constructor
	DtSplitMessageHandle (const DtSplitMessageHandle &orig)
	copy constructor
virtual	~DtSplitMessageHandle ()
	Destructor.
virtual DtSplitMessageHandle *	clone () const
	Required override. Copies itself.
virtual int	netRepSize () const
	returns sizeof(DtNetSplitMessageHandle)
virtual bool	setFromNet (const char *networkBuffer, unsigned contentSize)
	Sets members based on DtNetSplitMessageHandle buffer.
virtual bool	setToNet (char *pBuffer)
	assigns member values to DtNetSplitMessageHandle in preparation for transmission via the network.
virtual void	printDataToString (DtString &str)
DtU32	fullMessageSize () const
	accessors & mutators
void	setFullMessageSize (DtU32 nSize)
	accessors & mutators
bool	isSignalMessage () const
	Indicates if the original message went out as a signal interaction.
void	setIsSignalMessage (bool bSignal)
	Indicates if the original message went out as a signal interaction.
const DtSimulationAddress &	messageSimulationId () const
	represents the simulator that sent the original oversized message
void	setMessageSimulationId (const DtSimulationAddress &addr)
	represents the simulator that sent the original oversized message
DtU16	messageNumber () const
	Used in combination with messageSimulationId(), identify the orignal oversized message.
void	setMessageNumber (DtU16 newNum)
	Used in combination with messageSimulationId(), identify the orignal oversized message.
DtU16	numberOfChunks () const
	Gives the number of chunks to expect for the split up message.
void	setNumberOfChunks (DtU16 newNum)
	Gives the number of chunks to expect for the split up message.
Protected Member Functions
const DtSplitMessageHandle &	operator= (DtSplitMessageHandle &orig)
	Not used.
Protected Attributes
bool	myIsSignalMessage
	signal message?
DtU32	myFullMessageSize
	This represents the buffer length of the original content.
DtU16	myNumberOfChunks
	This is the number of DtIfSplitContent chunks that are expected for the original content.
DtSimulationAddress	myMessageSimulationId
DtU16	myMessageNumber

---

Detailed Description

A DtSplitMessageHandle.

Created by DtVrfObjectMessage when content size exceeds packet buffer size. A split message handle is used by DtVrfObjectMessage when the content of a message is larger than the maximum packet buffer size in VR-Link. Instead of sending the actual content in the DtVrfObjectMessage, a network representation of DtSplitMessageHandle is sent instead. The original content is issued through DtVrfMessageInterface::sendSplitContent() and tracked according to the DtSplitMessageHandle. On the receiving end, a DtVrfObjectMessage with DtSplitMessageHandle content will be held until the split content is reassembled. Thereafter, the DtVrfObjectMessage will be processed normally.

---

Constructor & Destructor Documentation

DtSplitMessageHandle::DtSplitMessageHandle

(

)

constructor

DtSplitMessageHandle::DtSplitMessageHandle

(

const DtSplitMessageHandle &

orig

)

copy constructor

virtual DtSplitMessageHandle::~DtSplitMessageHandle

(

)

[virtual]

Destructor.

---

Member Function Documentation

const DtSplitMessageHandle& DtSplitMessageHandle::operator=

(

DtSplitMessageHandle &

orig

)

[protected]

Not used.

virtual DtSplitMessageHandle* DtSplitMessageHandle::clone

(

)

const [virtual]

Required override. Copies itself.

virtual int DtSplitMessageHandle::netRepSize

(

)

const [virtual]

returns sizeof(DtNetSplitMessageHandle)

virtual bool DtSplitMessageHandle::setFromNet	(	const char *	networkBuffer,
		unsigned	contentSize
	)		[virtual]

Sets members based on DtNetSplitMessageHandle buffer.

virtual bool DtSplitMessageHandle::setToNet

(

char *

pBuffer

)

[virtual]

assigns member values to DtNetSplitMessageHandle in preparation for transmission via the network.

pBuffer is assumed to contain at least netRepSize() bytes.

virtual void DtSplitMessageHandle::printDataToString

(

DtString &

str

)

[virtual]

DtU32 DtSplitMessageHandle::fullMessageSize

(

)

const [inline]

accessors & mutators

Gives the size of the original message content.

References myFullMessageSize.

void DtSplitMessageHandle::setFullMessageSize

(

DtU32

nSize

)

[inline]

accessors & mutators

Gives the size of the original message content.

References myFullMessageSize.

bool DtSplitMessageHandle::isSignalMessage

(

)

const [inline]

Indicates if the original message went out as a signal interaction.

References myIsSignalMessage.

void DtSplitMessageHandle::setIsSignalMessage

(

bool

bSignal

)

[inline]

Indicates if the original message went out as a signal interaction.

References myIsSignalMessage.

const DtSimulationAddress & DtSplitMessageHandle::messageSimulationId

(

)

const [inline]

represents the simulator that sent the original oversized message

References myMessageSimulationId.

void DtSplitMessageHandle::setMessageSimulationId

(

const DtSimulationAddress &

addr

)

[inline]

represents the simulator that sent the original oversized message

References myMessageSimulationId.

DtU16 DtSplitMessageHandle::messageNumber

(

)

const [inline]

Used in combination with messageSimulationId(), identify the orignal oversized message.

References myMessageNumber.

void DtSplitMessageHandle::setMessageNumber

(

DtU16

newNum

)

[inline]

Used in combination with messageSimulationId(), identify the orignal oversized message.

References myMessageNumber.

DtU16 DtSplitMessageHandle::numberOfChunks

(

)

const [inline]

Gives the number of chunks to expect for the split up message.

References myNumberOfChunks.

void DtSplitMessageHandle::setNumberOfChunks

(

DtU16

newNum

)

[inline]

Gives the number of chunks to expect for the split up message.

References myNumberOfChunks.

---

Member Data Documentation

DtSimulationAddress DtSplitMessageHandle::myMessageSimulationId [protected]

/brief these combine to identify the original message by the simulation address of the issuing application, and a numeric ID assigned to that message. The message ID is used to reconstruct the original message on the receiving end.

Referenced by messageSimulationId(), and setMessageSimulationId().

DtU16 DtSplitMessageHandle::myMessageNumber [protected]

/brief these combine to identify the original message by the simulation address of the issuing application, and a numeric ID assigned to that message. The message ID is used to reconstruct the original message on the receiving end.

Referenced by messageNumber(), and setMessageNumber().

bool DtSplitMessageHandle::myIsSignalMessage [protected]

signal message?

Referenced by isSignalMessage(), and setIsSignalMessage().

DtU32 DtSplitMessageHandle::myFullMessageSize [protected]

This represents the buffer length of the original content.

Referenced by fullMessageSize(), and setFullMessageSize().

DtU16 DtSplitMessageHandle::myNumberOfChunks [protected]

This is the number of DtIfSplitContent chunks that are expected for the original content.

Referenced by numberOfChunks(), and setNumberOfChunks().

---

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

• include/vrfmsgs/splitMsgHandle.h