Common types and functions

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.
#define	DDS_PROTOCOLVERSION_1_0   { 1, 0 }
	The protocol version 1.0.
#define	DDS_PROTOCOLVERSION_1_1   { 1, 1 }
	The protocol version 1.1.
#define	DDS_PROTOCOLVERSION_1_2   { 1, 2 }
	The protocol version 1.2.
#define	DDS_PROTOCOLVERSION_2_0   { 2, 0 }
	The protocol version 2.0.
#define	DDS_PROTOCOLVERSION_2_1   { 2, 1 }
	The protocol version 2.1.
#define	DDS_PROTOCOLVERSION   { 2, 1 }
	The most recent protocol version. Currently 1.2.
#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_ProtocolVersion_t	DDS_ProtocolVersion_t
	<<eXtension>> Type used to represent the version of the RTPS protocol.
typedef struct DDS_BuiltinTopicKey_t	DDS_BuiltinTopicKey_t
	The key type of the built-in topic types.

Variables
struct DDS_Locator_t	DDS_LOCATOR_INVALID
	An invalid locator.
const DDS_Long	DDS_LOCATOR_KIND_INVALID
	Locator of this kind is invalid.
const DDS_UnsignedLong	DDS_LOCATOR_PORT_INVALID
	An invalid port.
const DDS_Octet	DDS_LOCATOR_ADDRESS_INVALID [DDS_LOCATOR_ADDRESS_LENGTH_MAX]
	An invalid address.
const DDS_Long	DDS_LOCATOR_KIND_UDPv4
	A locator for a UDPv4 address.
const DDS_Long	DDS_LOCATOR_KIND_SHMEM
	A locator for an address acessed via shared memory.
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.

Detailed Description

Types and functions related to the built-in topics.

Macro Definition Documentation

#define DDS_LOCATOR_ADDRESS_LENGTH_MAX   16

Declares length of address field in locator.

#define DDS_PROTOCOLVERSION_1_0   { 1, 0 }

The protocol version 1.0.

#define DDS_PROTOCOLVERSION_1_1   { 1, 1 }

The protocol version 1.1.

#define DDS_PROTOCOLVERSION_1_2   { 1, 2 }

The protocol version 1.2.

#define DDS_PROTOCOLVERSION_2_0   { 2, 0 }

The protocol version 2.0.

#define DDS_PROTOCOLVERSION_2_1   { 2, 1 }

The protocol version 2.1.

#define DDS_PROTOCOLVERSION   { 2, 1 }

The most recent protocol version. Currently 1.2.

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

Typedef Documentation

typedef struct DDS_ProtocolVersion_t DDS_ProtocolVersion_t

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

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.

See Also

DDS_ParticipantBuiltinTopicData

DDS_TopicBuiltinTopicData

DDS_PublicationBuiltinTopicData

DDS_SubscriptionBuiltinTopicData

Variable Documentation

struct DDS_Locator_t DDS_LOCATOR_INVALID

An invalid locator.

const DDS_Long DDS_LOCATOR_KIND_INVALID

Locator of this kind is invalid.

const DDS_UnsignedLong DDS_LOCATOR_PORT_INVALID

An invalid port.

const DDS_Octet DDS_LOCATOR_ADDRESS_INVALID[DDS_LOCATOR_ADDRESS_LENGTH_MAX]

An invalid address.

const DDS_Long DDS_LOCATOR_KIND_UDPv4

A locator for a UDPv4 address.

const DDS_Long DDS_LOCATOR_KIND_SHMEM

A locator for an address acessed via shared memory.

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.