RTI Connext C API Version 7.4.0
DDS_SubscriptionBuiltinTopicData Struct Reference

Entry created when a DDS_DataReader is discovered in association with its Subscriber. More...

Data Fields

DDS_BuiltinTopicKey_t key
 DCPS key to distinguish entries. More...
 
DDS_BuiltinTopicKey_t participant_key
 DCPS key of the participant to which the DataReader belongs. More...
 
char * topic_name
 Name of the related DDS_Topic. More...
 
char * type_name
 Name of the type attached to the DDS_Topic. More...
 
struct DDS_DurabilityQosPolicy durability
 Policy of the corresponding DataReader. More...
 
struct DDS_DeadlineQosPolicy deadline
 Policy of the corresponding DataReader. More...
 
struct DDS_LatencyBudgetQosPolicy latency_budget
 Policy of the corresponding DataReader. More...
 
struct DDS_LivelinessQosPolicy liveliness
 Policy of the corresponding DataReader. More...
 
struct DDS_ReliabilityQosPolicy reliability
 Policy of the corresponding DataReader. More...
 
struct DDS_OwnershipQosPolicy ownership
 Policy of the corresponding DataReader. More...
 
struct DDS_DestinationOrderQosPolicy destination_order
 Policy of the corresponding DataReader. More...
 
struct DDS_UserDataQosPolicy user_data
 Policy of the corresponding DataReader. More...
 
struct DDS_TimeBasedFilterQosPolicy time_based_filter
 Policy of the corresponding DataReader. More...
 
struct DDS_PresentationQosPolicy presentation
 Policy of the Subscriber to which the DataReader belongs. More...
 
struct DDS_PartitionQosPolicy partition
 Policy of the Subscriber to which the DataReader belongs. More...
 
struct DDS_TopicDataQosPolicy topic_data
 Policy of the related Topic. More...
 
struct DDS_GroupDataQosPolicy group_data
 Policy of the Subscriber to which the DataReader belongs. More...
 
struct DDS_TypeConsistencyEnforcementQosPolicy type_consistency
 Policy of the corresponding DataReader. More...
 
struct DDS_DataRepresentationQosPolicy representation
 Data representation policy of the corresponding DataReader. More...
 
DDS_DataTagQosPolicy data_tags
 Tags of the corresponding DataReader. More...
 
struct DDS_TypeCodetype_code
 <<extension>> Type code information of the corresponding Topic More...
 
DDS_BuiltinTopicKey_t subscriber_key
 <<extension>> DCPS key of the subscriber to which the DataReader belongs. More...
 
struct DDS_PropertyQosPolicy property
 <<extension>> Properties of the corresponding DataReader. More...
 
struct DDS_LocatorSeq unicast_locators
 <<extension>> Custom unicast locators that the endpoint can specify. The default locators will be used if this is not specified. More...
 
struct DDS_LocatorSeq multicast_locators
 <<extension>> Custom multicast locators that the endpoint can specify. The default locators will be used if this is not specified. More...
 
struct DDS_ContentFilterProperty_t content_filter_property
 <<extension>> This field provides all the required information to enable content filtering on the Writer side. More...
 
struct DDS_GUID_t virtual_guid
 <<extension>> Virtual GUID associated to the DataReader. More...
 
struct DDS_ServiceQosPolicy service
 <<extension>> Policy of the corresponding DataReader. More...
 
DDS_ProtocolVersion_t rtps_protocol_version
 <<extension>> Version number of the RTPS wire protocol used. More...
 
struct DDS_VendorId_t rtps_vendor_id
 <<extension>> ID of vendor implementing the RTPS wire protocol. More...
 
struct DDS_ProductVersion_t product_version
 <<extension>> This is a vendor specific parameter. It gives the current version of RTI Connext More...
 
DDS_Boolean disable_positive_acks
 <<extension>> This is a vendor specific parameter. Determines whether the corresponding DataReader sends positive acknowledgments for reliability. More...
 
struct DDS_EntityNameQosPolicy subscription_name
 <<extension>> The subscription name and role name. More...
 
struct DDS_EndpointTrustProtectionInfo trust_protection_info
 <<extension>> Trust plugins protection information associated with the discovered DataReader. More...
 
struct DDS_EndpointTrustAlgorithmInfo trust_algorithm_info
 <<extension>> Trust Plugins algorithms associated with the discovered DataReader. More...
 
DDS_BuiltinTopicKey_t related_datawriter_key
 <<extension>> Key of the related DataWriter that is created as a part of the Remote Procedure Call (RPC) or Request-Reply endpoints. More...
 

Detailed Description

Entry created when a DDS_DataReader is discovered in association with its Subscriber.

Data associated with the built-in topic DDS_SUBSCRIPTION_TOPIC_NAME. It contains QoS policies and additional information that apply to the remote DDS_DataReader the related DDS_Subscriber.

See also
DDS_SUBSCRIPTION_TOPIC_NAME
DDS_SubscriptionBuiltinTopicDataDataReader

Field Documentation

◆ key

DDS_BuiltinTopicKey_t DDS_SubscriptionBuiltinTopicData::key

DCPS key to distinguish entries.

◆ participant_key

DDS_BuiltinTopicKey_t DDS_SubscriptionBuiltinTopicData::participant_key

DCPS key of the participant to which the DataReader belongs.

◆ topic_name

char* DDS_SubscriptionBuiltinTopicData::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 Conventions.

See also
String Conventions

◆ type_name

char* DDS_SubscriptionBuiltinTopicData::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 Conventions.

See also
String Conventions

◆ durability

struct DDS_DurabilityQosPolicy DDS_SubscriptionBuiltinTopicData::durability

Policy of the corresponding DataReader.

◆ deadline

struct DDS_DeadlineQosPolicy DDS_SubscriptionBuiltinTopicData::deadline

Policy of the corresponding DataReader.

◆ latency_budget

struct DDS_LatencyBudgetQosPolicy DDS_SubscriptionBuiltinTopicData::latency_budget

Policy of the corresponding DataReader.

◆ liveliness

struct DDS_LivelinessQosPolicy DDS_SubscriptionBuiltinTopicData::liveliness

Policy of the corresponding DataReader.

◆ reliability

struct DDS_ReliabilityQosPolicy DDS_SubscriptionBuiltinTopicData::reliability

Policy of the corresponding DataReader.

◆ ownership

struct DDS_OwnershipQosPolicy DDS_SubscriptionBuiltinTopicData::ownership

Policy of the corresponding DataReader.

◆ destination_order

struct DDS_DestinationOrderQosPolicy DDS_SubscriptionBuiltinTopicData::destination_order

Policy of the corresponding DataReader.

Warning
Only the field DDS_DestinationOrderQosPolicy::kind is propagated during discovery. The other fields always contain their default values.

◆ user_data

struct DDS_UserDataQosPolicy DDS_SubscriptionBuiltinTopicData::user_data

Policy of the corresponding DataReader.

◆ time_based_filter

struct DDS_TimeBasedFilterQosPolicy DDS_SubscriptionBuiltinTopicData::time_based_filter

Policy of the corresponding DataReader.

◆ presentation

struct DDS_PresentationQosPolicy DDS_SubscriptionBuiltinTopicData::presentation

Policy of the Subscriber to which the DataReader belongs.

◆ partition

struct DDS_PartitionQosPolicy DDS_SubscriptionBuiltinTopicData::partition

Policy of the Subscriber to which the DataReader belongs.

◆ topic_data

struct DDS_TopicDataQosPolicy DDS_SubscriptionBuiltinTopicData::topic_data

Policy of the related Topic.

◆ group_data

struct DDS_GroupDataQosPolicy DDS_SubscriptionBuiltinTopicData::group_data

Policy of the Subscriber to which the DataReader belongs.

◆ type_consistency

struct DDS_TypeConsistencyEnforcementQosPolicy DDS_SubscriptionBuiltinTopicData::type_consistency

Policy of the corresponding DataReader.

◆ representation

struct DDS_DataRepresentationQosPolicy DDS_SubscriptionBuiltinTopicData::representation

Data representation policy of the corresponding DataReader.

◆ data_tags

DDS_DataTagQosPolicy DDS_SubscriptionBuiltinTopicData::data_tags

Tags of the corresponding DataReader.

◆ type_code

struct DDS_TypeCode* DDS_SubscriptionBuiltinTopicData::type_code

<<extension>> Type code information of the corresponding Topic

◆ subscriber_key

DDS_BuiltinTopicKey_t DDS_SubscriptionBuiltinTopicData::subscriber_key

<<extension>> DCPS key of the subscriber to which the DataReader belongs.

◆ property

struct DDS_PropertyQosPolicy DDS_SubscriptionBuiltinTopicData::property

<<extension>> Properties of the corresponding DataReader.

◆ unicast_locators

struct DDS_LocatorSeq DDS_SubscriptionBuiltinTopicData::unicast_locators

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

◆ multicast_locators

struct DDS_LocatorSeq DDS_SubscriptionBuiltinTopicData::multicast_locators

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

◆ content_filter_property

struct DDS_ContentFilterProperty_t DDS_SubscriptionBuiltinTopicData::content_filter_property

<<extension>> This field provides all the required information to enable content filtering on the Writer side.

◆ virtual_guid

struct DDS_GUID_t DDS_SubscriptionBuiltinTopicData::virtual_guid

<<extension>> Virtual GUID associated to the DataReader.

See also
DDS_GUID_t

◆ service

struct DDS_ServiceQosPolicy DDS_SubscriptionBuiltinTopicData::service

<<extension>> Policy of the corresponding DataReader.

◆ rtps_protocol_version

DDS_ProtocolVersion_t DDS_SubscriptionBuiltinTopicData::rtps_protocol_version

<<extension>> Version number of the RTPS wire protocol used.

◆ rtps_vendor_id

struct DDS_VendorId_t DDS_SubscriptionBuiltinTopicData::rtps_vendor_id

<<extension>> ID of vendor implementing the RTPS wire protocol.

◆ product_version

struct DDS_ProductVersion_t DDS_SubscriptionBuiltinTopicData::product_version

<<extension>> This is a vendor specific parameter. It gives the current version of RTI Connext

◆ disable_positive_acks

DDS_Boolean DDS_SubscriptionBuiltinTopicData::disable_positive_acks

<<extension>> This is a vendor specific parameter. Determines whether the corresponding DataReader sends positive acknowledgments for reliability.

◆ subscription_name

struct DDS_EntityNameQosPolicy DDS_SubscriptionBuiltinTopicData::subscription_name

<<extension>> The subscription name and role name.

This member contains the name and the role name of the discovered subscription.

◆ trust_protection_info

struct DDS_EndpointTrustProtectionInfo DDS_SubscriptionBuiltinTopicData::trust_protection_info

<<extension>> Trust plugins protection information associated with the discovered DataReader.

Trust Plugins is a generic abstraction that represents any plugin intended to do transformation, interception, and validation of exchanged data and metadata.

trust_protection_info contains information about how RTPS wire serialization, discovery, and liveliness interact with the loaded Trust Plugins. Two endpoints will not match if their trust_protection_info is incompatible.

The meaning of the contents of this field may vary depending on what Trust Plugins the endpoint is using. For information about how this field interacts with the RTI Security Plugins, please refer to the RTI Security Plugins User's Manual.

◆ trust_algorithm_info

struct DDS_EndpointTrustAlgorithmInfo DDS_SubscriptionBuiltinTopicData::trust_algorithm_info

<<extension>> Trust Plugins algorithms associated with the discovered DataReader.

Trust Plugins is a generic abstraction that represents any plugin intended to do transformation, interception, and validation of exchanged data and metadata.

trust_algorithm_info contains information about what algorithms the loaded Trust Plugins are running. Two endpoints will not match if their trust_algorithm_info are incompatible.

The meaning of the contents of this field may vary depending on what Trust Plugins the endpoint is using. For information about how this field interacts with the RTI Security Plugins, please refer to the RTI Security Plugins User's Manual.

◆ related_datawriter_key

DDS_BuiltinTopicKey_t DDS_SubscriptionBuiltinTopicData::related_datawriter_key

<<extension>> Key of the related DataWriter that is created as a part of the Remote Procedure Call (RPC) or Request-Reply endpoints.

This field will be set to something other than DDS_BUILTIN_TOPIC_KEY_UNKNOWN only when the discovered DataReader is a part of Remote Procedure Call (RPC) or Request-Reply endpoints.