DtMetadataHeader_s Struct Reference

The metadata header structure has the following components: type: one of the DtMetadataType values hasPayload: if 1 indicates metadata has a payload and lenOrVal contains the payload length, padding, and alignment bits copy: if 1 indicates the metadata header and payload must be copied with the message more: if 1 indicates additional metadata included in message packet lenOrVal: if hasPayload is 0 this field contains the value of the metadata if hasPayload is 1 this field contains the following components - payloadLen: length of actual payload excluding padding. More...

Collaboration diagram for DtMetadataHeader_s:

List of all members.

Classes
union	DtMetadataHeaderCtl_u
union	DtMetadataHeaderLenOrVal_u
Public Attributes
union DtMetadataHeader_s::DtMetadataHeaderCtl_u	ctl
union DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u	lenOrVal

---

Detailed Description

The metadata header structure has the following components: type: one of the DtMetadataType values hasPayload: if 1 indicates metadata has a payload and lenOrVal contains the payload length, padding, and alignment bits copy: if 1 indicates the metadata header and payload must be copied with the message more: if 1 indicates additional metadata included in message packet lenOrVal: if hasPayload is 0 this field contains the value of the metadata if hasPayload is 1 this field contains the following components - payloadLen: length of actual payload excluding padding.

2047 bytes MAX. pad: number of bytes of padding required to align metadata header alignPad: number of bytes of padding required to align metadata payload payloadAlignment: Must be set if the payload requires alignment so forwarders can maintain alignment. 0 = no alignment, 1 = 16-bit, 2 = not used, 3 = 32-bit

---

Member Data Documentation

union DtMetadataHeader_s::DtMetadataHeaderCtl_u DtMetadataHeader_s::ctl

Referenced by DtRtiMetadata::compactMetadata(), DtRtiMetadata::getHeaderByType(), DtRtiMetadata::isCopyEnabled(), DtRtiMetadata::locate(), DtRtiMetadata::metadataPayloadSize(), DtRtiMetadata::metadataSize(), DtRtiMetadata::nullify(), DtRtiMetadata::purge(), DtRtiMetadata::remove(), DtRtiMetadata::reverseTransmogrifyHeader(), DtRtiMtdNull::set(), DtRtiMtdMcastAddr::set(), DtRtiMtdTimeStamp::set(), DtRtiMtdTestId::set(), DtRtiMtdForwarderGroupId::set(), DtRtiMtdDestinationList::set(), DtRtiMtdFederateHostInformation::set(), DtRtiMetadata::setCopyEnable(), DtRtiMetadata::setLengthAsValue(), and DtRtiMetadata::transmogrifyHeader().

union DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u DtMetadataHeader_s::lenOrVal

Referenced by DtRtiMetadata::compactMetadata(), DtRtiMetadata::locate(), DtRtiMetadata::metadataPayloadSize(), DtRtiMetadata::metadataSize(), DtRtiMetadata::reverseTransmogrifyHeader(), DtRtiMtdNull::set(), DtRtiMtdMcastAddr::set(), DtRtiMtdTimeStamp::set(), DtRtiMtdTestId::set(), DtRtiMtdDestinationList::set(), DtRtiMtdForwarderGroupId::set(), DtRtiMtdFederateHostInformation::set(), DtRtiMetadata::setLengthAsValue(), and DtRtiMetadata::transmogrifyHeader().

---

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

• metadata.h