RTI Connext Micro C++ API Version 4.3.0
Loading...
Searching...
No Matches

Descriptions of remote entities used for discovery. More...

Topics

 Participant Built-in Topic
 Builtin topic for accessing information about the DomainParticipants discovered by RTI Connext DDS Micro.
 
 Publication Built-in Topic
 Builtin topic for configuring information about the Publications to be discovered by RTI Connext DDS Micro.
 
 Subscription Built-in Topic
 Builtin topic for configuring information about the Subscriptions to be discovered by RTI Connext DDS Micro.
 

Classes

struct  DDS_ContentFilterProperty
 All of the information necessary for a DDSDataWriter to perform writer-side filtering for a DDSDataReader. More...
 
struct  DDS_ChecksumProperty_t
 <<eXtension>> Type to define the checksum properties of the participant RTI Connext DDS Micro. More...
 
struct  DDS_Locator_t
 <<eXtension>> Type used to represent the addressing information needed to send a message to an RTPS Endpoint using one of the supported transports. More...
 
struct  DDS_LocatorSeq
 Declares IDL sequence < DDS_Locator_t > More...
 
struct  DDS_LocatorEx
 <<eXtension>> Type used to represent the addressing information needed to send a message to an RTPS Endpoint using one of the supported transports. More...
 
struct  DDS_ProtocolVersion_t
 <<eXtension>> Type used to represent the version of the RTPS protocol. More...
 
struct  DDS_VendorId_t
 <<eXtension>> Type used to represent the vendor of the service implementing the RTPS protocol. More...
 
struct  DDS_ProductVersion_t
 <<eXtension>> Type used to represent the current version of RTI Connext DDS Micro. More...
 
struct  DDS_BuiltinTopicKey_t
 The key type of the built-in topic types. More...
 

Macros

#define DDS_VENDOR_ID_LENGTH_MAX   2
 Length of vendor id.
 
#define DDS_PRODUCTVERSION_UNKNOWN   { 0, 0, '0', 0 }
 The value used when the product version is unknown.
 

Typedefs

typedef struct DDS_BuiltinTopicKey_t DDS_BuiltinTopicKey_t
 The key type of the built-in topic types.
 

Variables

const DDS_Long DDS_LOCATOR_ADDRESS_LENGTH_MAX
 Declares length of address field in locator.
 
const struct DDS_Locator_t DDS_LOCATOR_INVALID
 An invalid locator.
 
const DDS_Long DDS_LOCATOR_KIND_UDPv4
 A locator for a UDPv4 address.
 
const DDS_Long DDS_LOCATOR_KIND_UDPv6
 A locator for a UDPv6 address.
 
const DDS_Long DDS_LOCATOR_KIND_RESERVED
 Locator of this kind is reserved.
 
const DDS_Long DDS_LOCATOR_KIND_SHMEM
 A locator for an address accessed via shared memory.
 
const DDS_ProtocolVersion_t DDS_PROTOCOLVERSION_1_0
 The protocol version 1.0.
 
const DDS_ProtocolVersion_t DDS_PROTOCOLVERSION_1_1
 The protocol version 1.1.
 
const DDS_ProtocolVersion_t DDS_PROTOCOLVERSION_1_2
 The protocol version 1.2.
 
const DDS_ProtocolVersion_t DDS_PROTOCOLVERSION_2_0
 The protocol version 2.0.
 
const DDS_ProtocolVersion_t DDS_PROTOCOLVERSION_2_1
 The protocol version 2.1.
 
const DDS_ProtocolVersion_t DDS_PROTOCOLVERSION
 The most recent protocol version. Currently 2.5.
 

Detailed Description

Descriptions of remote entities used for discovery.

Given a DDS entity, a remote entity is any other entity that can be discovered and matched. A built-in object is a description of a remote entity, including all the QoS which are important for discovery and matching of remote readers and writers with local readers and writers.

RTI Connext DDS Micro must discover and keep track of the remote entities, such as new participants in the domain. Depending on the type of discovery used, this information about remote entities is gathered in three ways:

1. No data is sent over the network (static discovery)

2. A subset is sent over the network (dynamic participant/static endpoint discovery), while the rest is statically asserted.

3. All data about DomainParticipants DataReaders and DataWriters is over the network (simple discovery)

In the first case, all information about remote DomainParticipants DataReaders and DataWriters is statically configured by the user before starting the middleware. To do this static configuration, the user must fill in the built-in structures for all remote entities it wishes to discover, and must asssert them to the middleware. This type of discovery is not supported in this version of RTI Connext DDS Micro.

In the second case, the participant data is sent over the network, but the endpoint data is statically configured. So, the local application fills in builtin structures representing the QoS and object IDs all the remote readers and writers it wishes to discover. For this type of discovery the user does not configure builtin data for remote participants. This type of discovery is faster than Simple Discovery, and does not require reliable communication. This is supported by RTI Connext DDS Micro and is known as Dynamic Participant, Static Endpoint (DPSE) discovery.

In the last case, the user does not need to fill in any data about remote entities, because it is automatically sent over the network by the middleware. The user can access the data through special listeners for discovery traffic.

This is supported by RTI Connext DDS Micro and is known as Dynamic Participant, Dynamic Endpoint (DPDE) discovery. Refer to DDS_ParticipantBuiltinTopicData, DDS_SubscriptionBuiltinTopicData and DDS_PublicationBuiltinTopicData for a description of all the built-in topics and their contents.

<<eXtension>> Dynamic Participant, Static Endpoint Discovery plugin mechanism for RTI Connext DDS Micro.

Macro Definition Documentation

◆ DDS_VENDOR_ID_LENGTH_MAX

#define DDS_VENDOR_ID_LENGTH_MAX   2

Length of vendor id.

◆ DDS_PRODUCTVERSION_UNKNOWN

#define DDS_PRODUCTVERSION_UNKNOWN   { 0, 0, '0', 0 }

The value used when the product version is unknown.

Typedef Documentation

◆ DDS_BuiltinTopicKey_t

typedef struct DDS_BuiltinTopicKey_t DDS_BuiltinTopicKey_t

The key type of the built-in topic types.

Each remote DDSEntity to be discovered can be uniquely identified by this key. This is the key of all the built-in topic data types.

The value of element DDS_BUILTIN_TOPIC_KEY_OBJECT_ID is the object ID of the remote entity. In Dynamic Participant/Static Endpoint discovery, this must be set correctly for each remote DDSDataReader and DDSDataWriter that an application intends to discover.

For example, to configure a remote DDSDataWriter with object ID 100 by setting the key in the DDS_PublicationBuiltinTopicData:

remote_pub_data.key.value[DDS_BUILTIN_TOPIC_KEY_OBJECT_ID] = 100;
See also
DDS_ParticipantBuiltinTopicData
DDS_PublicationBuiltinTopicData
DDS_SubscriptionBuiltinTopicData

Variable Documentation

◆ DDS_LOCATOR_ADDRESS_LENGTH_MAX

const DDS_Long DDS_LOCATOR_ADDRESS_LENGTH_MAX

Declares length of address field in locator.

◆ DDS_LOCATOR_INVALID

const struct DDS_Locator_t DDS_LOCATOR_INVALID

An invalid locator.

◆ DDS_LOCATOR_KIND_UDPv4

const DDS_Long DDS_LOCATOR_KIND_UDPv4

A locator for a UDPv4 address.

◆ DDS_LOCATOR_KIND_UDPv6

const DDS_Long DDS_LOCATOR_KIND_UDPv6

A locator for a UDPv6 address.

◆ DDS_LOCATOR_KIND_RESERVED

const DDS_Long DDS_LOCATOR_KIND_RESERVED

Locator of this kind is reserved.

◆ DDS_LOCATOR_KIND_SHMEM

const DDS_Long DDS_LOCATOR_KIND_SHMEM

A locator for an address accessed via shared memory.

◆ DDS_PROTOCOLVERSION_1_0

const DDS_ProtocolVersion_t DDS_PROTOCOLVERSION_1_0

The protocol version 1.0.

◆ DDS_PROTOCOLVERSION_1_1

const DDS_ProtocolVersion_t DDS_PROTOCOLVERSION_1_1

The protocol version 1.1.

◆ DDS_PROTOCOLVERSION_1_2

const DDS_ProtocolVersion_t DDS_PROTOCOLVERSION_1_2

The protocol version 1.2.

◆ DDS_PROTOCOLVERSION_2_0

const DDS_ProtocolVersion_t DDS_PROTOCOLVERSION_2_0

The protocol version 2.0.

◆ DDS_PROTOCOLVERSION_2_1

const DDS_ProtocolVersion_t DDS_PROTOCOLVERSION_2_1

The protocol version 2.1.

◆ DDS_PROTOCOLVERSION

const DDS_ProtocolVersion_t DDS_PROTOCOLVERSION

The most recent protocol version. Currently 2.5.