RTI Connext Traditional C++ API Version 7.3.0

Types and functions related to the built-in topics. More...

Classes

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_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. More...
 
struct  DDS_TransportInfo_t
 Contains the class_id and message_size_max of an installed transport. More...
 
struct  DDS_TransportInfoSeq
 Instantiates FooSeq < DDS_TransportInfo_t > . More...
 
struct  DDS_BuiltinTopicKey_t
 The key type of the built-in topic types. More...
 
struct  DDS_ContentFilterProperty_t
 <<extension>> Type used to provide all the required information to enable content filtering. More...
 

Macros

#define DDS_LOCATOR_ADDRESS_LENGTH_MAX   16
 Declares length of address field in locator. More...
 
#define DDS_PROTOCOLVERSION_1_0   { 1, 0 }
 The protocol version 1.0. More...
 
#define DDS_PROTOCOLVERSION_1_1   { 1, 1 }
 The protocol version 1.1. More...
 
#define DDS_PROTOCOLVERSION_1_2   { 1, 2 }
 The protocol version 1.2. More...
 
#define DDS_PROTOCOLVERSION_2_0   { 2, 0 }
 The protocol version 2.0. More...
 
#define DDS_PROTOCOLVERSION_2_1   { 2, 1 }
 The protocol version 2.1. More...
 
#define DDS_PROTOCOLVERSION   { 2, 1 }
 The most recent protocol version. Currently 2.1. More...
 
#define DDS_VENDOR_ID_LENGTH_MAX   2
 Length of vendor id. More...
 
#define DDS_PRODUCTVERSION_UNKNOWN
 The value used when the product version is unknown. More...
 

Typedefs

typedef struct DDS_Locator_t 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...
 
typedef struct DDS_ProtocolVersion_t DDS_ProtocolVersion_t
 <<extension>> Type used to represent the version of the RTPS protocol. More...
 
typedef struct DDS_BuiltinTopicKey_t DDS_BuiltinTopicKey_t
 The key type of the built-in topic types. More...
 

Functions

DDS_Boolean DDS_BuiltinTopicKey_equals (const DDS_BuiltinTopicKey_t *self, const DDS_BuiltinTopicKey_t *other)
 Compares this Key with another Key for equality. More...
 
void DDS_BuiltinTopicKey_copy (DDS_BuiltinTopicKey_t *dst, const DDS_BuiltinTopicKey_t *src)
 Copies another Key into this Key. More...
 
void DDS_BuiltinTopicKey_to_guid (const DDS_BuiltinTopicKey_t *self, DDS_GUID_t *dst)
 Converts this Key into a GUID. More...
 
void DDS_BuiltinTopicKey_from_guid (DDS_BuiltinTopicKey_t *self, const DDS_GUID_t *src)
 Initializes this Key from the input GUID. More...
 
DDS_Boolean DDS_BuiltinTopicKey_to_instance_handle (const DDS_BuiltinTopicKey_t *self, DDS_InstanceHandle_t *dst)
 Converts this Key into an InstanceHandle. More...
 
DDS_Boolean DDS_BuiltinTopicKey_from_instance_handle (DDS_BuiltinTopicKey_t *self, const DDS_InstanceHandle_t *src)
 Initializes this Key from the input InstanceHandle. More...
 

Variables

const struct DDS_Locator_t DDS_LOCATOR_INVALID
 An invalid locator. More...
 
const DDS_Long DDS_LOCATOR_KIND_INVALID
 Locator of this kind is invalid. More...
 
const DDS_UnsignedLong DDS_LOCATOR_PORT_INVALID
 An invalid port. More...
 
const DDS_Octet DDS_LOCATOR_ADDRESS_INVALID [DDS_LOCATOR_ADDRESS_LENGTH_MAX]
 An invalid address. More...
 
const DDS_Long DDS_LOCATOR_KIND_UDPv4
 A locator for a UDPv4 address. More...
 
const DDS_Long DDS_LOCATOR_KIND_UDPv4_WAN
 A locator for a UDPv4 asymmetric transport address. More...
 
const DDS_Long DDS_LOCATOR_KIND_SHMEM
 A locator for an address acessed via shared memory. More...
 
const DDS_Long DDS_LOCATOR_KIND_SHMEM_510
 A locator for an address acessed via shared memory for RTI Connext 5.1.0 and earlier. More...
 
const DDS_Long DDS_LOCATOR_KIND_UDPv6
 A locator for a UDPv6 address. More...
 
const DDS_Long DDS_LOCATOR_KIND_UDPv6_510
 A locator for a UDPv6 address for RTI Connext 5.1.0 and earlier. More...
 
const DDS_Long DDS_LOCATOR_KIND_RESERVED
 Locator of this kind is reserved. More...
 

Detailed Description

Types and functions related to the built-in topics.

Macro Definition Documentation

◆ DDS_LOCATOR_ADDRESS_LENGTH_MAX

#define DDS_LOCATOR_ADDRESS_LENGTH_MAX   16

Declares length of address field in locator.

◆ DDS_PROTOCOLVERSION_1_0

#define DDS_PROTOCOLVERSION_1_0   { 1, 0 }

The protocol version 1.0.

◆ DDS_PROTOCOLVERSION_1_1

#define DDS_PROTOCOLVERSION_1_1   { 1, 1 }

The protocol version 1.1.

◆ DDS_PROTOCOLVERSION_1_2

#define DDS_PROTOCOLVERSION_1_2   { 1, 2 }

The protocol version 1.2.

◆ DDS_PROTOCOLVERSION_2_0

#define DDS_PROTOCOLVERSION_2_0   { 2, 0 }

The protocol version 2.0.

◆ DDS_PROTOCOLVERSION_2_1

#define DDS_PROTOCOLVERSION_2_1   { 2, 1 }

The protocol version 2.1.

◆ DDS_PROTOCOLVERSION

#define DDS_PROTOCOLVERSION   { 2, 1 }

The most recent protocol version. Currently 2.1.

◆ DDS_VENDOR_ID_LENGTH_MAX

#define DDS_VENDOR_ID_LENGTH_MAX   2

Length of vendor id.

◆ DDS_PRODUCTVERSION_UNKNOWN

#define DDS_PRODUCTVERSION_UNKNOWN
Value:
{ \
DDS_PRODUCTVERSION_MAJOR_UNKNOWN, \
DDS_PRODUCTVERSION_MINOR_UNKNOWN, \
DDS_PRODUCTVERSION_RELEASE_UNKNOWN, \
DDS_PRODUCTVERSION_REVISION_UNKNOWN \
}

The value used when the product version is unknown.

Typedef Documentation

◆ DDS_Locator_t

typedef struct DDS_Locator_t 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.

◆ DDS_ProtocolVersion_t

<<extension>> Type used to represent the version of the RTPS protocol.

◆ 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.

See also
DDS_ParticipantBuiltinTopicData
DDS_TopicBuiltinTopicData
DDS_PublicationBuiltinTopicData
DDS_SubscriptionBuiltinTopicData

Function Documentation

◆ DDS_BuiltinTopicKey_equals()

DDS_Boolean DDS_BuiltinTopicKey_equals ( const DDS_BuiltinTopicKey_t self,
const DDS_BuiltinTopicKey_t other 
)

Compares this Key with another Key for equality.

Parameters
self<<in>> This Key. Cannot be NULL.
other<<in>> The other Key to be compared with this Key. Cannot be NULL.
Returns
DDS_BOOLEAN_TRUE if the two Keys have equal values, or DDS_BOOLEAN_FALSE otherwise.

◆ DDS_BuiltinTopicKey_copy()

void DDS_BuiltinTopicKey_copy ( DDS_BuiltinTopicKey_t dst,
const DDS_BuiltinTopicKey_t src 
)

Copies another Key into this Key.

Parameters
dst<<out>> This Key. Cannot be NULL.
src<<in>> The other Key to be copied. Cannot be NULL.

◆ DDS_BuiltinTopicKey_to_guid()

void DDS_BuiltinTopicKey_to_guid ( const DDS_BuiltinTopicKey_t self,
DDS_GUID_t dst 
)

Converts this Key into a GUID.

Parameters
self<<in>> This Key. Cannot be NULL.
dst<<out>> The destination GUID. Cannot be NULL.

◆ DDS_BuiltinTopicKey_from_guid()

void DDS_BuiltinTopicKey_from_guid ( DDS_BuiltinTopicKey_t self,
const DDS_GUID_t src 
)

Initializes this Key from the input GUID.

Parameters
self<<out>> This Key. Cannot be NULL.
src<<in>> The GUID to be used to initialize this Key. Cannot be NULL.

◆ DDS_BuiltinTopicKey_to_instance_handle()

DDS_Boolean DDS_BuiltinTopicKey_to_instance_handle ( const DDS_BuiltinTopicKey_t self,
DDS_InstanceHandle_t dst 
)

Converts this Key into an InstanceHandle.

Parameters
self<<in>> This Key. Cannot be NULL.
dst<<out>> The destination InstanceHandle. Cannot be NULL.
Returns
DDS_BOOLEAN_TRUE on success or DDS_BOOLEAN_FALSE on failure

◆ DDS_BuiltinTopicKey_from_instance_handle()

DDS_Boolean DDS_BuiltinTopicKey_from_instance_handle ( DDS_BuiltinTopicKey_t self,
const DDS_InstanceHandle_t src 
)

Initializes this Key from the input InstanceHandle.

Parameters
self<<out>> This Key. Cannot be NULL.
src<<in>> The InstanceHandle to be used to initialize this Key. Cannot be NULL.
Returns
DDS_BOOLEAN_TRUE on success or DDS_BOOLEAN_FALSE on failure

Variable Documentation

◆ DDS_LOCATOR_INVALID

const struct DDS_Locator_t DDS_LOCATOR_INVALID
extern

An invalid locator.

◆ DDS_LOCATOR_KIND_INVALID

const DDS_Long DDS_LOCATOR_KIND_INVALID
extern

Locator of this kind is invalid.

◆ DDS_LOCATOR_PORT_INVALID

const DDS_UnsignedLong DDS_LOCATOR_PORT_INVALID
extern

An invalid port.

◆ DDS_LOCATOR_ADDRESS_INVALID

const DDS_Octet DDS_LOCATOR_ADDRESS_INVALID[DDS_LOCATOR_ADDRESS_LENGTH_MAX]
extern

An invalid address.

◆ DDS_LOCATOR_KIND_UDPv4

const DDS_Long DDS_LOCATOR_KIND_UDPv4
extern

A locator for a UDPv4 address.

◆ DDS_LOCATOR_KIND_UDPv4_WAN

const DDS_Long DDS_LOCATOR_KIND_UDPv4_WAN
extern

A locator for a UDPv4 asymmetric transport address.

◆ DDS_LOCATOR_KIND_SHMEM

const DDS_Long DDS_LOCATOR_KIND_SHMEM
extern

A locator for an address acessed via shared memory.

◆ DDS_LOCATOR_KIND_SHMEM_510

const DDS_Long DDS_LOCATOR_KIND_SHMEM_510
extern

A locator for an address acessed via shared memory for RTI Connext 5.1.0 and earlier.

◆ DDS_LOCATOR_KIND_UDPv6

const DDS_Long DDS_LOCATOR_KIND_UDPv6
extern

A locator for a UDPv6 address.

◆ DDS_LOCATOR_KIND_UDPv6_510

const DDS_Long DDS_LOCATOR_KIND_UDPv6_510
extern

A locator for a UDPv6 address for RTI Connext 5.1.0 and earlier.

◆ DDS_LOCATOR_KIND_RESERVED

const DDS_Long DDS_LOCATOR_KIND_RESERVED
extern

Locator of this kind is reserved.