DtMsgHeaderReader Class Reference

The DtMsgHeaderReader class provides an interface to read data from the headers of messages. More...

Inheritance diagram for DtMsgHeaderReader:

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

Detailed Description

The DtMsgHeaderReader class provides an interface to read data from the headers of messages.

Need by the socket classes to provide a generic way of reading fields from messages.

Constructor & Destructor Documentation

virtual DtMsgHeaderReader::~DtMsgHeaderReader ( )

inlinevirtual

Member Function Documentation

virtual size_t DtMsgHeaderReader::bytesForSize ( ) const

pure virtual

Bytes of data required before message size can be determined.

Implemented in DtAssistantMsgHeaderReader, and DtRtiMsgHeaderReader.

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

pure virtual

Get the location and size of the message body.

Returns false if the message contains no body.

Implemented in DtAssistantMsgHeaderReader, and DtRtiMsgHeaderReader.

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

pure virtual

Get the location and size of the message header.

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

Implemented in DtAssistantMsgHeaderReader, and DtRtiMsgHeaderReader.

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

pure virtual

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

Returns false if the message does not contain a trailer.

Implemented in DtAssistantMsgHeaderReader, and DtRtiMsgHeaderReader.

virtual bool DtMsgHeaderReader::hasMetadata ( const char *  msg, size_t  size  ) const

pure virtual

Whether the message contains metadata.

Implemented in DtAssistantMsgHeaderReader, and DtRtiMsgHeaderReader.

virtual bool DtMsgHeaderReader::isBundled ( const char *  msg, size_t  size  ) const

pure virtual

Whether the message is part of a bundle.

Implemented in DtAssistantMsgHeaderReader, and DtRtiMsgHeaderReader.

virtual bool DtMsgHeaderReader::isCompressed ( const char *  msg, size_t  size  ) const

pure virtual

Whether the message is compressed.

Implemented in DtAssistantMsgHeaderReader, and DtRtiMsgHeaderReader.

virtual size_t DtMsgHeaderReader::messageSize ( const char *  msg, size_t  size  ) const

pure virtual

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

Implemented in DtAssistantMsgHeaderReader, and DtRtiMsgHeaderReader.

virtual void DtMsgHeaderReader::setBundled ( char *  msg, size_t  size, bool  bundled  ) const

pure virtual

Set whether message is part of a bundle.

Implemented in DtAssistantMsgHeaderReader, and DtRtiMsgHeaderReader.

virtual void DtMsgHeaderReader::setCompressed ( char *  msg, size_t  size, bool  compressed  ) const

pure virtual

Set whether message is compressed.

Implemented in DtAssistantMsgHeaderReader, and DtRtiMsgHeaderReader.

virtual void DtMsgHeaderReader::setMessageSize ( char *  msg, size_t  size, size_t  newSize  ) const

pure virtual

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

Implemented in DtAssistantMsgHeaderReader, and DtRtiMsgHeaderReader.

---

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

• msgHeaderReader.h