Module types

Source

Structs§

Time
Time_t Type used to hold a timestamp. Should have at least nano-second resolution. The following values are reserved by the protocol: TIME_ZERO, TIME_INVALID, TIME_INFINITE

Enums§

ProtocolId
ProtocolId_t Enumeration used to identify the protocol. The following values are reserved by the protocol: PROTOCOL_RTPS
SubmessageKind
SubmessageKind Enumeration used to identify the kind of Submessage. The following values are reserved by this version of the protocol: DATA, GAP, HEARTBEAT, ACKNACK, PAD, INFO_TS, INFO_REPLY, INFO_DST, INFO_SRC, DATA_FRAG, NACK_FRAG, HEARTBEAT_FRAG

Constants§

ACKNACK
DATA
DATA_FRAG
GAP
HEARTBEAT
HEARTBEAT_FRAG
INFO_DST
INFO_REPLY
INFO_SRC
INFO_TS
NACK_FRAG
PAD
TIME_INFINITE
TIME_INVALID
TIME_ZERO

Type Aliases§

Checksum32
Checksum_t Type used to hold a checksum. Used to detect RTPS message corruption by the underlying transport. The following values are reserved by the protocol: CHECKSUM_INVALID.
Count
Count_t Type used to hold a count that is incremented monotonically, used to identify message duplicates.
FragmentNumber
FragmentNumber_t Type used to hold fragment numbers. Must be possible to represent using 32 bits.
GroupDigest
GroupDigest_t Type used to hold a digest value that uniquely identifies a group of Entities belonging to the same Participant.
ParameterId
ParameterId_t Type used to uniquely identify a parameter in a parameter list. Used extensively by the Discovery Module mainly to define QoS Parameters. A range of values is reserved for protocol-defined parameters, while another range can be used for vendor-defined parameters, see 8.3.5.9.
SubmessageFlag
SubmessageFlag Type used to specify a Submessage flag. A Submessage flag takes a boolean value and affects the parsing of the Submessage by the receiver.
UExtension4
UExtension4_t Type used to hold an undefined 4-byte value. It is intended to be used in future revisions of the specification.
WExtension8
WExtension8_t Type used to hold an undefined 8-byte value. It is intended to be used in future revisions of the specification.