DtRtiMsgHeaderReader Class Reference

The DtRtiMsgHeaderReader class reads data from RTI message headers. More...

Inheritance diagram for DtRtiMsgHeaderReader:

Collaboration diagram for DtRtiMsgHeaderReader:

List of all members.

Public Member Functions
	DtRtiMsgHeaderReader ()
virtual	~DtRtiMsgHeaderReader ()
virtual bool	isBundled (const char *msg, size_t size) const
	Whether the message is part of a bundle.
virtual void	setBundled (char *msg, size_t size, bool bundled) const
	Set whether message is part of a bundle.
virtual bool	isCompressed (const char *msg, size_t size) const
	Whether the message is compressed.
virtual void	setCompressed (char *msg, size_t size, bool compressed) const
	Set whether message is compressed.
virtual bool	hasMetadata (const char *msg, size_t size) const
	Whether the message contains metadata.
virtual bool	getMessageHeader (char *msg, size_t size, char **hdr, size_t &hdrSize) const
	Get the location and size of the message header.
virtual bool	getMessageBody (char *msg, size_t size, char **body, size_t &bodySize) const
	Get the location and size of the message body.
virtual bool	getMessageTrailer (char *msg, size_t size, char **trlr, size_t &trlrSize) const
	Get the location and size of the message trailer (generally metadata).
virtual size_t	messageSize (const char *msg, size_t size) const
	Determine the size of the whole message (including header and metadata)
virtual void	setMessageSize (char *msg, size_t size, size_t newSize) const
	Sets the size of the whole message (including header and metadata)
virtual size_t	bytesForSize () const
	Bytes of data required before message size can be determined.
Protected Attributes
size_t	myBytesForSize
	Number of bytes needed to read the message size.
size_t	myBytesForHeader
	Number of bytes needed for a full message header.

---

Detailed Description

The DtRtiMsgHeaderReader class reads data from RTI message headers.

---

Constructor & Destructor Documentation

DtRtiMsgHeaderReader::DtRtiMsgHeaderReader

(

)

References myBytesForHeader, myBytesForSize, and DtNetMsgHeader::totalSize.

DtRtiMsgHeaderReader::~DtRtiMsgHeaderReader

(

)

[virtual]

---

Member Function Documentation

size_t DtRtiMsgHeaderReader::bytesForSize

(

)

const [virtual]

Bytes of data required before message size can be determined.

Implements DtMsgHeaderReader.

References myBytesForSize.

bool DtRtiMsgHeaderReader::getMessageBody	(	char *	msg,
		size_t	size,
		char **	body,
		size_t &	bodySize
	)		const [virtual]

Get the location and size of the message body.

Returns false if the message contains no body.

Implements DtMsgHeaderReader.

References DtNetMsgHeader::metadataSize, and myBytesForHeader.

bool DtRtiMsgHeaderReader::getMessageHeader	(	char *	msg,
		size_t	size,
		char **	hdr,
		size_t &	hdrSize
	)		const [virtual]

Get the location and size of the message header.

Returns false if the message does not contain a full header.

Implements DtMsgHeaderReader.

References myBytesForHeader.

bool DtRtiMsgHeaderReader::getMessageTrailer	(	char *	msg,
		size_t	size,
		char **	trlr,
		size_t &	trlrSize
	)		const [virtual]

Get the location and size of the message trailer (generally metadata).

Returns false if the message does not contain a trailer.

Implements DtMsgHeaderReader.

References DtNetMsgHeader::metadataSize, and myBytesForHeader.

bool DtRtiMsgHeaderReader::hasMetadata	(	const char *	msg,
		size_t	size
	)		const [virtual]

Whether the message contains metadata.

Implements DtMsgHeaderReader.

References DtNetMsgHeader::metadataInMessage(), and myBytesForHeader.

bool DtRtiMsgHeaderReader::isBundled	(	const char *	msg,
		size_t	size
	)		const [virtual]

Whether the message is part of a bundle.

Implements DtMsgHeaderReader.

References DtNetMsgHeader::isBundled(), and myBytesForHeader.

bool DtRtiMsgHeaderReader::isCompressed	(	const char *	msg,
		size_t	size
	)		const [virtual]

Whether the message is compressed.

Implements DtMsgHeaderReader.

References DtNetMsgHeader::isCompressed(), and myBytesForHeader.

size_t DtRtiMsgHeaderReader::messageSize	(	const char *	msg,
		size_t	size
	)		const [virtual]

Determine the size of the whole message (including header and metadata)

Implements DtMsgHeaderReader.

References myBytesForSize, and DtNetMsgHeader::totalSize.

void DtRtiMsgHeaderReader::setBundled	(	char *	msg,
		size_t	size,
		bool	bundled
	)		const [virtual]

Set whether message is part of a bundle.

Implements DtMsgHeaderReader.

References myBytesForHeader, and DtNetMsgHeader::setIsBundled().

void DtRtiMsgHeaderReader::setCompressed	(	char *	msg,
		size_t	size,
		bool	compressed
	)		const [virtual]

Set whether message is compressed.

Implements DtMsgHeaderReader.

References myBytesForHeader, and DtNetMsgHeader::setIsCompressed().

void DtRtiMsgHeaderReader::setMessageSize	(	char *	msg,
		size_t	size,
		size_t	newSize
	)		const [virtual]

Sets the size of the whole message (including header and metadata)

Implements DtMsgHeaderReader.

References myBytesForSize, and DtNetMsgHeader::totalSize.

---

Member Data Documentation

size_t DtRtiMsgHeaderReader::myBytesForHeader [protected]

Number of bytes needed for a full message header.

Referenced by DtRtiMsgHeaderReader(), getMessageBody(), getMessageHeader(), getMessageTrailer(), hasMetadata(), isBundled(), isCompressed(), setBundled(), and setCompressed().

size_t DtRtiMsgHeaderReader::myBytesForSize [protected]

Number of bytes needed to read the message size.

Referenced by bytesForSize(), DtRtiMsgHeaderReader(), messageSize(), and setMessageSize().

---

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

• rtiMsgHeaderReader.h
• rtiMsgHeaderReader.cxx