RTI Connext Micro C API Version 4.2.0
Loading...
Searching...
No Matches
DDS_PublicationBuiltinTopicData Struct Reference

Object describing a remote Publication. More...

#include <dds_c_discovery.h>

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_LatencyBudgetQosPolicy latency_budget
 Latency budget policy, LATENCY_BUDGET.
 
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
 <<eXtension>> Custom unicast locators that the endpoint can specify. The default locators will be used if this is not specified.
 
struct DDS_DataRepresentationQosPolicy representation
 Data representation policy, DATA_REPRESENTATION.
 
struct DDS_PartitionQosPolicy partition
 Policy of the Publisher to which the DataWriter belongs.
 
struct DDS_UserDataQosPolicy user_data
 Policy of the corresponding DataWriter.
 
struct DDS_GroupDataQosPolicy group_data
 Policy of the Publisher to which the DataWriter belongs.
 
struct DDS_TopicDataQosPolicy topic_data
 Policy of the related Topic.
 

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

◆ key

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.

◆ participant_key

struct DDS_BuiltinTopicKey_t DDS_PublicationBuiltinTopicData::participant_key

DCPS key of the participant to which the DataWriter belongs.

◆ topic_name

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

See also
Conventions

◆ type_name

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

See also
Conventions

◆ deadline

struct DDS_DeadlineQosPolicy DDS_PublicationBuiltinTopicData::deadline

Policy of the corresponding DataWriter.

◆ ownership

struct DDS_OwnershipQosPolicy DDS_PublicationBuiltinTopicData::ownership

Policy of the corresponding DataWriter.

◆ ownership_strength

struct DDS_OwnershipStrengthQosPolicy DDS_PublicationBuiltinTopicData::ownership_strength

Policy of the corresponding DataWriter.

◆ latency_budget

struct DDS_LatencyBudgetQosPolicy DDS_PublicationBuiltinTopicData::latency_budget

Latency budget policy, LATENCY_BUDGET.

◆ reliability

struct DDS_ReliabilityQosPolicy DDS_PublicationBuiltinTopicData::reliability

Policy of the corresponding DataWriter.

◆ liveliness

struct DDS_LivelinessQosPolicy DDS_PublicationBuiltinTopicData::liveliness

Policy of the corresponding DataWriter.

◆ durability

struct DDS_DurabilityQosPolicy DDS_PublicationBuiltinTopicData::durability

durability policy of the corresponding DataWriter

◆ destination_order

struct DDS_DestinationOrderQosPolicy DDS_PublicationBuiltinTopicData::destination_order

Policy of the corresponding DataWriter.

◆ unicast_locator

struct DDS_LocatorSeq DDS_PublicationBuiltinTopicData::unicast_locator

<<eXtension>> Custom unicast locators that the endpoint can specify. The default locators will be used if this is not specified.

◆ representation

struct DDS_DataRepresentationQosPolicy DDS_PublicationBuiltinTopicData::representation

Data representation policy, DATA_REPRESENTATION.

◆ partition

struct DDS_PartitionQosPolicy DDS_PublicationBuiltinTopicData::partition

Policy of the Publisher to which the DataWriter belongs.

◆ user_data

struct DDS_UserDataQosPolicy DDS_PublicationBuiltinTopicData::user_data

Policy of the corresponding DataWriter.

◆ group_data

struct DDS_GroupDataQosPolicy DDS_PublicationBuiltinTopicData::group_data

Policy of the Publisher to which the DataWriter belongs.

◆ topic_data

struct DDS_TopicDataQosPolicy DDS_PublicationBuiltinTopicData::topic_data

Policy of the related Topic.