RTI Connext Micro C API  2.4.14.2
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
DDS_PublicationBuiltinTopicData Struct Reference

Object describing a remote Publication. More...

Data Fields

struct DDS_BuiltinTopicKey_t key
 DCPS key to distinguish entries. This is used to configure the object ID of the remote DDS_DataWriter.
struct DDS_BuiltinTopicKey_t participant_key
 DCPS key of the participant to which the DataWriter belongs.
char * topic_name
 Name of the related DDS_Topic.
char * type_name
 Name of the type attached to the DDS_Topic.
struct DDS_DeadlineQosPolicy deadline
 Policy of the corresponding DataWriter.
struct DDS_OwnershipQosPolicy ownership
 Policy of the corresponding DataWriter.
struct
DDS_OwnershipStrengthQosPolicy 
ownership_strength
 Policy of the corresponding DataWriter.
struct DDS_ReliabilityQosPolicy reliability
 Policy of the corresponding DataWriter.
struct DDS_LivelinessQosPolicy liveliness
 Policy of the corresponding DataWriter.
struct DDS_DurabilityQosPolicy durability
 durability policy of the corresponding DataWriter
struct
DDS_DestinationOrderQosPolicy 
destination_order
 Policy of the corresponding DataWriter.
struct DDS_LocatorSeq unicast_locator
 Custom unicast locator sequence that the endpoint can specify. The default locator sequence from the DDS_DomainParticipant will be used if this is not specified.

Detailed Description

Object describing a remote Publication.

This object contains all of the information about a remote DDS_DataWriter and its DDS_Publisher that is necessary for matching the remote DDS_DataWriter to a local DDS_DataReader during discovery.

This object is used to pre-configure remote entities for Dynamic Participant/Static Endpoint discovery.

For example: Application A is designed to discover a remote DDS_DataWriter in application B, and that remote DDS_DataWriter has an object ID of 100, and a deadline of three seconds. In Dynamic Participant/Static Endpoint discovery, this discovery data is not sent over the network, so the user must create an instance of a DDS_PublicationBuiltinTopicData structure in application A. The user then must fill in the QoS describing this remote DDS_DataWriter, including the writer's object ID and three-second deadline. Then the user must assert this DDS_PublicationBuiltinTopicData describing the remote entity with the discovery plugin. The pre-configured QoS must match the actual QoS of the remote entity, or communication will not occur.


Field Documentation

struct DDS_BuiltinTopicKey_t DDS_PublicationBuiltinTopicData::key

DCPS key to distinguish entries. This is used to configure the object ID of the remote DDS_DataWriter.

struct DDS_BuiltinTopicKey_t DDS_PublicationBuiltinTopicData::participant_key

DCPS key of the participant to which the DataWriter belongs.

char* DDS_PublicationBuiltinTopicData::topic_name

Name of the related DDS_Topic.

The length of this string is limited to 255 characters.

The memory for this field is managed as described in String Support.

See also:
String Support
char* DDS_PublicationBuiltinTopicData::type_name

Name of the type attached to the DDS_Topic.

The length of this string is limited to 255 characters.

The memory for this field is managed as described in String Support.

See also:
String Support
struct DDS_DeadlineQosPolicy DDS_PublicationBuiltinTopicData::deadline

Policy of the corresponding DataWriter.

struct DDS_OwnershipQosPolicy DDS_PublicationBuiltinTopicData::ownership

Policy of the corresponding DataWriter.

struct DDS_OwnershipStrengthQosPolicy DDS_PublicationBuiltinTopicData::ownership_strength

Policy of the corresponding DataWriter.

struct DDS_ReliabilityQosPolicy DDS_PublicationBuiltinTopicData::reliability

Policy of the corresponding DataWriter.

struct DDS_LivelinessQosPolicy DDS_PublicationBuiltinTopicData::liveliness

Policy of the corresponding DataWriter.

struct DDS_DurabilityQosPolicy DDS_PublicationBuiltinTopicData::durability

durability policy of the corresponding DataWriter

struct DDS_DestinationOrderQosPolicy DDS_PublicationBuiltinTopicData::destination_order

Policy of the corresponding DataWriter.

struct DDS_LocatorSeq DDS_PublicationBuiltinTopicData::unicast_locator

Custom unicast locator sequence that the endpoint can specify. The default locator sequence from the DDS_DomainParticipant will be used if this is not specified.


RTI Connext Micro C API 2.4.14.2 Copyright © Tue May 28 2024 Real-Time Innovations, Inc