metadata.h File Reference

This file contains the declaration of the DtRtiMetadata class which provides a framework for subclasses of RTI message metadata. More...

Go to the source code of this file.

Classes
struct	DtMetadataHeader_s
	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...
union	DtMetadataHeader_s::DtMetadataHeaderCtl_u
struct	DtMetadataHeader_s::DtMetadataHeaderCtl_u::DtMetadataHeaderCtl_s
union	DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u
struct	DtMetadataHeader_s::DtMetadataHeaderLenOrVal_u::DtMetadataHeaderPayloadLen_s
class	DtRtiMetadata
	DtRtiMetadata is added to some RTI messages depending on the configuration of the RTI. More...

Macros
#define	DtMetadataAlignNone   0
#define	DtMetadataAlign16Bit   1
#define	DtMetadataAlign32Bit   3
#define	DtMetadataAlign64Bit   7

Typedefs
typedef enum DtMetadataTypes_e	DtMetadataType
typedef struct DtMetadataHeader_s	DtMetadataNetHeader
	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.

Enumerations

enum

DtMetadataTypes_e {   DtMetadataTypeNull = 0, DtMetadataTypeDestinationList, DtMetadataTypeTransport, DtMetadataTypeMcastAddr,   DtMetadataTypeFwderGroupId, DtMetadataTypeTestId, DtMetadataTypeTimeStampInitiatorSendInteraction, DtMetadataTypeTimeStampInitiatorNetSend,   DtMetadataTypeTimeStampRecipientNetRead, DtMetadataTypeTimeStampRecipientAsynchronousQueue, DtMetadataTypeTimeStampRecipientReceiveInteraction, DtMetadataTypeTimeStampRecipientSendInteraction,   DtMetadataTypeTimeStampRecipientNetSend, DtMetadataTypeTimeStampInitiatorNetRead, DtMetadataTypeTimeStampInitiatorAsynchronousQueue, DtMetadataTypeTimeStampInitiatorReceiveInteraction,   DtMetadataTypeFederateStateInfo, DtMetadataTypeEnd = 8191 }

Detailed Description

This file contains the declaration of the DtRtiMetadata class which provides a framework for subclasses of RTI message metadata.

Macro Definition Documentation

#define DtMetadataAlign16Bit   1

#define DtMetadataAlign32Bit   3

#define DtMetadataAlign64Bit   7

#define DtMetadataAlignNone   0

Typedef Documentation

typedef struct DtMetadataHeader_s DtMetadataNetHeader

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

typedef enum DtMetadataTypes_e DtMetadataType

Enumeration Type Documentation

enum DtMetadataTypes_e

Enumerator:

DtMetadataTypeNull
DtMetadataTypeDestinationList
DtMetadataTypeTransport
DtMetadataTypeMcastAddr
DtMetadataTypeFwderGroupId
DtMetadataTypeTestId
DtMetadataTypeTimeStampInitiatorSendInteraction
DtMetadataTypeTimeStampInitiatorNetSend
DtMetadataTypeTimeStampRecipientNetRead
DtMetadataTypeTimeStampRecipientAsynchronousQueue
DtMetadataTypeTimeStampRecipientReceiveInteraction
DtMetadataTypeTimeStampRecipientSendInteraction
DtMetadataTypeTimeStampRecipientNetSend
DtMetadataTypeTimeStampInitiatorNetRead
DtMetadataTypeTimeStampInitiatorAsynchronousQueue
DtMetadataTypeTimeStampInitiatorReceiveInteraction
DtMetadataTypeFederateStateInfo
DtMetadataTypeEnd