DtRtiMtdNull Class Reference

Inheritance diagram for DtRtiMtdNull:

Collaboration diagram for DtRtiMtdNull:

Public Member Functions
	DtRtiMtdNull (caddr_t msg)
	Constructor.
	DtRtiMtdNull (DtRtiMsg *msg)
virtual	~DtRtiMtdNull ()
	Destructor.
virtual bool	get () const
	Find the first null metadata block within the message metadata.
virtual bool	set ()
	Reserves space in RTI message buffer (if necessary) for a null metadata block which consists entirely of a metadata header.
Public Member Functions inherited from DtRtiMetadata
	DtRtiMetadata (caddr_t msg, DtMetadataType type)
	Constructor.
	DtRtiMetadata (DtRtiMsg *msg, DtMetadataType type)
virtual	~DtRtiMetadata ()
	Destructor.
virtual bool	locate (void **mdVal, unsigned int &size) const
	Traverse metadata headers of attached message to find this instance's metadata type.
virtual bool	nullify ()
	Find specified type and change type field in header to DtMetadataTypeNull but don't remove from message buffer.
virtual unsigned int	remove ()
	Find specified type and remove from buffer, relocating metadata that remains and adjusting reported size of buffer.
virtual unsigned int	purge ()
	Traverse metadata headers to find all nullified blocks and remove them from buffer, relocating metadata that remains and adjusting reported size of buffer.
virtual bool	isCopyEnabled ()
	Set/Get the 'copy' bit in the specified metadata header.
virtual void	setCopyEnable (bool copyEnable)
virtual bool	setLengthAsValue (unsigned int value)
	Set an integer value to be transmitted without using an actual payload.
virtual bool	getLengthAsValue (unsigned int &value) const
	Get an integer payload value from the payload length.

Protected Attributes
const unsigned int	myPayloadAlignment
Protected Attributes inherited from DtRtiMetadata
DtRtiMsg *	myMsg
caddr_t	myMsgAddr
unsigned int	myMsgLen
char *	myStartAddr
unsigned int	mySize
	address returned by DtRtiMsg::addMetadata()
bool	myCopyEnabled
const DtMetadataType	myMetaDataType

Private Member Functions
	DtRtiMtdNull (const DtRtiMtdNull &)
	Copy CTOR Not Implemented – Copy Not Allowed!
DtRtiMtdNull &	operator= (const DtRtiMtdNull &)
	Assignment Operator Not Implemented – Assignment Not Allowed!

Additional Inherited Members
Static Public Member Functions inherited from DtRtiMetadata
static unsigned int	metadataMaxSize ()
	Report maximum size of metadata buffer.
Protected Types inherited from DtRtiMetadata
typedef std::list < DtMetadataNetHeader * >	DtMetadataHeaderList
Protected Member Functions inherited from DtRtiMetadata
virtual DtMetadataNetHeader *	getFirstHeader () const
virtual DtMetadataNetHeader *	getHeaderByType () const
virtual DtU16	compactMetadata (char *dst, DtMetadataHeaderList &retentionPool, bool newFinal)
Static Protected Member Functions inherited from DtRtiMetadata
static bool	locate (char const *msg, DtMetadataType type, void **mdVal, unsigned int &size)
	Traverse metadata headers of the given message to find the given metadata type.
static bool	typeIsPresent (char const *msg, DtMetadataType type)
	Determines whether metadata type is present in msg.
static DtMetadataNetHeader *	getFirstHeader (char const *msg)
static DtMetadataNetHeader *	getNextHeader (DtMetadataNetHeader *hdr)
static DtMetadataNetHeader *	getHeaderByType (char const *msg, DtMetadataType type)
static void	transmogrifyHeader (DtMetadataNetHeader &src, DtMetadataNetHeader &dest)
	Transform from network to host format.
static void	reverseTransmogrifyHeader (DtMetadataNetHeader &src, DtMetadataNetHeader &dest)
	Transform from host format to network format.
static unsigned int	metadataSize (DtMetadataNetHeader &hdr)
static unsigned int	metadataPayloadSize (DtMetadataNetHeader &hdr)
Static Protected Attributes inherited from DtRtiMetadata
static unsigned int	theMaxMetadataBufferSize = 2048

Constructor & Destructor Documentation

DtRtiMtdNull::DtRtiMtdNull

(

caddr_t

msg

)

Constructor.

DtRtiMtdNull::DtRtiMtdNull

(

DtRtiMsg *

msg

)

DtRtiMtdNull::~DtRtiMtdNull ( )

virtual

Destructor.

DtRtiMtdNull::DtRtiMtdNull ( const DtRtiMtdNull &  )

private

Copy CTOR Not Implemented – Copy Not Allowed!

Member Function Documentation

bool DtRtiMtdNull::get ( ) const

virtual

Find the first null metadata block within the message metadata.

Since this metadata is null, there is nothing to get and this method only serves to confirm that the entry exists. Return: found entry?

References DtRtiMetadata::locate().

DtRtiMtdNull& DtRtiMtdNull::operator= ( const DtRtiMtdNull &  )

private

Assignment Operator Not Implemented – Assignment Not Allowed!

bool DtRtiMtdNull::set ( )

virtual

Reserves space in RTI message buffer (if necessary) for a null metadata block which consists entirely of a metadata header.

Returns true if successful, false otherwise.

References DtRtiMsg::addMetadata(), DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u::DtMetadataHeaderPayloadLen_s::alignPad, DtMetadataHeader_s::DtMetadataHeaderCtl_u::DtMetadataHeaderCtl_s::copy, DtMetadataHeader_s::ctl, DtMetadataHeader_s::DtMetadataHeaderCtl_u::field, DtRtiMetadata::getHeaderByType(), DtMetadataHeader_s::DtMetadataHeaderCtl_u::DtMetadataHeaderCtl_s::hasPayload, DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u::len, DtMetadataHeader_s::lenOrVal, DtMetadataHeader_s::DtMetadataHeaderCtl_u::DtMetadataHeaderCtl_s::more, DtRtiMetadata::myCopyEnabled, DtRtiMetadata::myMetaDataType, DtRtiMetadata::myMsg, DtRtiMetadata::myMsgAddr, DtRtiMetadata::myMsgLen, myPayloadAlignment, DtRtiMetadata::myStartAddr, NULL, DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u::DtMetadataHeaderPayloadLen_s::pad, DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u::DtMetadataHeaderPayloadLen_s::payloadAlignment, DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u::DtMetadataHeaderPayloadLen_s::payloadLen, DtRtiMetadata::reverseTransmogrifyHeader(), and DtMetadataHeader_s::DtMetadataHeaderCtl_u::DtMetadataHeaderCtl_s::type.

Member Data Documentation

const unsigned int DtRtiMtdNull::myPayloadAlignment

protected

Referenced by set().

---

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

• metadataNull.h
• metadataNull.cxx