DtNetMsgHeader Class Reference

Collaboration diagram for DtNetMsgHeader:

Public Member Functions
bool	isForExec (const MAKRti::DtString &execName, unsigned short execHandle) const
	Returns true if the current message belongs to the indicated federation execution, false otherwise.
bool	versionMatches (int messageVersion) const
	Returns bool: given version matches version in header?
bool	metadataInMessage () const
	Accessor / Mutator for whether header indicates msg has metadata.
void	setMetadataInMessage (bool yesNo)
bool	isTestMgrMessage () const
	Accessor / Mutator for whether this is a test msg.
void	setIsTestMgrMessage (bool yesNo)
bool	isBundled () const
	Accessor / Mutator for whether this message is bundled.
void	setIsBundled (bool yesNo)
bool	isCompressed () const
	Accessor / Mutator for whether this message is compressed.
void	setIsCompressed (bool yesNo)

Public Attributes
DtNetU32	totalSize
DtNetU8	versionCheck
	Older versions had message kind here.
DtNetU8	msgKind
DtNetU8	flags
DtNetU8	fedExecId [DtNetExecNameSize]
	Five bytes representing either the first five characters of the execution name, or a zero byte followed by a four-byte execution handle.
DtNetU16	version
DtNetU16	fedHandle
DtNetU32	sequenceNumber
DtNetU32	metadataSize

Member Function Documentation

bool DtNetMsgHeader::isBundled

(

)

const

Accessor / Mutator for whether this message is bundled.

References flags.

Referenced by DtRtiMsgHeaderReader::isBundled().

bool DtNetMsgHeader::isCompressed

(

)

const

Accessor / Mutator for whether this message is compressed.

References flags.

Referenced by DtRtiMsgHeaderReader::isCompressed().

bool DtNetMsgHeader::isForExec	(	const MAKRti::DtString &	execName,
		unsigned short	execHandle
	)		const

Returns true if the current message belongs to the indicated federation execution, false otherwise.

If you are not using an rtiexec, use a handle of zero.

References DtNetExecNameSize, and fedExecId.

Referenced by DtRtiMsg::isForExec(), and DtRtiConnection::netRead().

bool DtNetMsgHeader::isTestMgrMessage

(

)

const

Accessor / Mutator for whether this is a test msg.

References flags.

bool DtNetMsgHeader::metadataInMessage

(

)

const

Accessor / Mutator for whether header indicates msg has metadata.

References flags.

Referenced by DtRtiMsg::addMetadata(), DtRtiMetadata::getFirstHeader(), DtTestManager::getTestIDFromMetaData(), DtRtiMsgHeaderReader::hasMetadata(), and DtRtiMsg::isMetadataPresent().

void DtNetMsgHeader::setIsBundled

(

bool

yesNo

)

References flags.

Referenced by DtRtiMsgHeaderReader::setBundled().

void DtNetMsgHeader::setIsCompressed

(

bool

yesNo

)

References flags.

Referenced by DtRtiMsgHeaderReader::setCompressed().

void DtNetMsgHeader::setIsTestMgrMessage

(

bool

yesNo

)

References flags.

void DtNetMsgHeader::setMetadataInMessage

(

bool

yesNo

)

References flags.

Referenced by DtRtiMsg::addMetadata().

bool DtNetMsgHeader::versionMatches

(

int

messageVersion

)

const

Returns bool: given version matches version in header?

References DtInvalidMsgKind, version, and versionCheck.

Referenced by DtRtiMsg::isValidVersion(), and DtRtiConnection::netRead().

Member Data Documentation

DtNetU8 DtNetMsgHeader::fedExecId[DtNetExecNameSize]

Five bytes representing either the first five characters of the execution name, or a zero byte followed by a four-byte execution handle.

Referenced by DtRtiMsg::fedExHandle(), isForExec(), and DtRtiMsg::setFedEx().

DtNetU16 DtNetMsgHeader::fedHandle

Referenced by DtMulticastSubscriptionProcessor::dropMulticastGroup(), DtRtiMsg::federateHandle(), DtSmartForwardingProcessor::federateJoined(), DtSmartForwardingProcessor::federateResigned(), DtRtiSmSocket::filterAnonMsgs(), DtMulticastSubscriptionProcessor::listenToMulticastGroup(), DtRtiConnection::netRead(), and DtRtiMsg::setFederateHandle().

DtNetU8 DtNetMsgHeader::flags

Referenced by DtPartnerMgr::acceptMessage(), isBundled(), isCompressed(), isTestMgrMessage(), metadataInMessage(), DtSmRtiConnection::send(), DtGsRtiConnection::send(), DtRtiConnection::send(), setIsBundled(), setIsCompressed(), setIsTestMgrMessage(), and setMetadataInMessage().

DtNetU32 DtNetMsgHeader::metadataSize

Referenced by DtRtiMsg::addMetadata(), DtRtiMsgHeaderReader::getMessageBody(), DtRtiMsgHeaderReader::getMessageTrailer(), and DtRtiMsg::initDtRtiMsg().

DtNetU8 DtNetMsgHeader::msgKind

Referenced by DtExternalRtiMsgFactory::create(), DtDeleteSocketMsg::DtDeleteSocketMsg(), DtDisconnectMsg::DtDisconnectMsg(), DtInitiatedSaveMsg::DtInitiatedSaveMsg(), DtRestoreCompleteMsg::DtRestoreCompleteMsg(), DtRtiExecDisconnectMsg::DtRtiExecDisconnectMsg(), DtSaveTimeAdvanceMsg::DtSaveTimeAdvanceMsg(), DtRtiMsg::initDtRtiMsg(), and DtRtiConnection::netRead().

DtNetU32 DtNetMsgHeader::sequenceNumber

Referenced by DtRtiMsg::sequenceNumber(), and DtRtiMsg::setSequenceNumber().

DtNetU32 DtNetMsgHeader::totalSize

Referenced by DtConnectConfirmMsg::DtConnectConfirmMsg(), DtRtiMsgHeaderReader::DtRtiMsgHeaderReader(), DtRtiMetadata::getFirstHeader(), DtRtiMsg::initDtRtiMsg(), DtRtiMsgHeaderReader::messageSize(), DtRtiConnection::netRead(), DtRtiMsgHeaderReader::setMessageSize(), and DtRtiMsg::sizeChanged().

DtNetU16 DtNetMsgHeader::version

Referenced by DtRtiMsg::initDtRtiMsg(), DtRtiConnection::netRead(), and versionMatches().

DtNetU8 DtNetMsgHeader::versionCheck

Older versions had message kind here.

Newer versions will put invalid message kind here.

Referenced by DtRtiMsg::initDtRtiMsg(), DtRtiConnection::netRead(), and versionMatches().

---

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

• netRtiMsgHdr.h
• rtiMsg.cxx