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.

Public Member Functions
	DtSplitMessageHandle ()

	DtSplitMessageHandle (const DtSplitMessageHandle &orig)

virtual	~DtSplitMessageHandle ()

virtual DtSplitMessageHandle *	clone () const

virtual int	netRepSize () const

virtual bool	setFromNet (const char *networkBuffer, unsigned contentSize)

virtual bool	setToNet (char *pBuffer)

virtual void	printDataToString (DtString &str)


DtU32	fullMessageSize () const

void	setFullMessageSize (DtU32 nSize)


bool	isSignalMessage () const

void	setIsSignalMessage (bool bSignal)


const DtSimulationAddress &	messageSimulationId () const

void	setMessageSimulationId (const DtSimulationAddress &addr)


DtU16	messageNumber () const

void	setMessageNumber (DtU16 newNum)


DtU16	numberOfChunks () const

void	setNumberOfChunks (DtU16 newNum)

Protected Member Functions
const DtSplitMessageHandle &	operator= (DtSplitMessageHandle &orig)

Protected Attributes
bool	myIsSignalMessage

DtU32	myFullMessageSize

DtU16	myNumberOfChunks


DtSimulationAddress	myMessageSimulationId

DtU16	myMessageNumber

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.