Module types

Source

Structs§

ChangeCount
ChangeCount_t Type used to hold a counter representing the number of HistoryCache changes that belong to a certain category. For example, the number of changes that have been filtered for an RTPS Reader endpoint.
EntityId
Guid
GUID_t Type used to hold globally-unique RTPS-entity identifiers. These are identifiers used to uniquely refer to each RTPS Entity in the system. Must be possible to represent using 16 octets. The following values are reserved by the protocol: GUID_UNKNOWN
Locator
Locator_t Type used to represent the addressing information needed to send a message to an RTPS Endpoint using one of the supported transports. Should be able to hold a discriminator identifying the kind of transport, an address, and a port number. It must be possible to represent the discriminator and port number using 4 octets each, the address using 16 octets. The following values are reserved by the protocol: LOCATOR_INVALID LOCATOR_KIND_INVALID LOCATOR_KIND_RESERVED LOCATOR_KIND_UDP_V4 LOCATOR_KIND_UDP_V6 LOCATOR_ADDRESS_INVALID LOCATOR_PORT_INVALID
ProtocolVersion
InstanceHandle_t Type used to represent the identity of a data-object whose changes in value are communicated by the RTPS protocol. ProtocolVersion_t Type used to represent the version of the RTPS protocol. The version is composed of a major and a minor version number. See also 8.6. The following values are reserved by the protocol: PROTOCOLVERSION PROTOCOLVERSION_1_0 PROTOCOLVERSION_1_1 PROTOCOLVERSION_2_0 PROTOCOLVERSION_2_1 PROTOCOLVERSION_2_2 PROTOCOLVERSION_2_4 PROTOCOLVERSION is an alias for the most recent version, in this case PROTOCOLVERSION_2_4
SequenceNumber
SequenceNumber_t Type used to hold sequence numbers. Must be possible to represent using 64 bits. The following values are reserved by the protocol: SEQUENCENUMBER_UNKNOWN

Enums§

ChangeKind
ChangeKind_t Enumeration used to distinguish the kind of change that was made to a data-object. Includes changes to the data or the instance state of the data-object. It can take the values: ALIVE, ALIVE_FILTERED, NOT_ALIVE_DISPOSED, NOT_ALIVE_UNREGISTERED
ReliabilityKind
ReliabilityKind_t Enumeration used to indicate the level of the reliability used for communications. It can take the values: BEST_EFFORT, RELIABLE.
TopicKind
TopicKind_t Enumeration used to distinguish whether a Topic has defined some fields within to be used as the ‘key’ that identifies data-instances within the Topic. See the DDS specification for more details on keys. The following values are reserved by the protocol: NO_KEY, WITH_KEY

Constants§

BUILT_IN_PARTICIPANT
BUILT_IN_READER_GROUP
BUILT_IN_READER_NO_KEY
BUILT_IN_READER_WITH_KEY
BUILT_IN_TOPIC
BUILT_IN_UNKNOWN
BUILT_IN_WRITER_GROUP
BUILT_IN_WRITER_NO_KEY
BUILT_IN_WRITER_WITH_KEY
ENTITYID_PARTICIPANT
ENTITYID_UNKNOWN
GUIDPREFIX_UNKNOWN
GUID_UNKNOWN
LOCATOR_ADDRESS_INVALID
LOCATOR_INVALID
LOCATOR_KIND_INVALID
LOCATOR_KIND_RESERVED
LOCATOR_KIND_UDP_V4
LOCATOR_KIND_UDP_V6
LOCATOR_PORT_INVALID
PROTOCOLVERSION
PROTOCOLVERSION_1_0
PROTOCOLVERSION_1_1
PROTOCOLVERSION_2_0
PROTOCOLVERSION_2_1
PROTOCOLVERSION_2_2
PROTOCOLVERSION_2_3
PROTOCOLVERSION_2_4
SEQUENCENUMBER_UNKNOWN
USER_DEFINED_READER_GROUP
USER_DEFINED_READER_NO_KEY
USER_DEFINED_READER_WITH_KEY
USER_DEFINED_TOPIC
USER_DEFINED_UNKNOWN
USER_DEFINED_WRITER_GROUP
USER_DEFINED_WRITER_NO_KEY
USER_DEFINED_WRITER_WITH_KEY
VENDOR_ID_S2E
VENDOR_ID_UNKNOWN

Type Aliases§

GuidPrefix
GuidPrefix_t Type used to hold the prefix of the globally-unique RTPS-entity identifiers. The GUIDs of entities belonging to the same participant all have the same prefix (see 8.2.4.3). Must be possible to represent using 12 octets. The following values are reserved by the protocol: GUIDPREFIX_UNKNOWN
VendorId
VendorId_t Type used to represent the vendor of the service implementing the RTPS protocol. The possible values for the vendorId are assigned by the OMG. The following values are reserved by the protocol: VENDORID_UNKNOWN