dds::topic::SubscriptionBuiltinTopicData Class Reference

Entry created when a dds::sub::DataReader is discovered in association with its dds::sub::Subscriber. More...

#include <dds/topic/BuiltinTopic.hpp>

Public Member Functions
	TSubscriptionBuiltinTopicData ()
	Create a default SubscriptionBuiltinTopicData. More...
const dds::topic::BuiltinTopicKey &	key () const
	Get the DCPS key to distinguish entries. More...
const dds::topic::BuiltinTopicKey &	participant_key () const
	Get the DCPS key of the dds::domain::DomainParticipant to which the dds::sub::DataReader belongs. More...
const dds::core::string &	topic_name () const
	Get the name of the related dds::topic::Topic. More...
const dds::core::string &	type_name () const
	Get the name of the type attached to the dds::topic::Topic. More...
const dds::core::policy::Durability &	durability () const
	Get the dds::core::policy::Durability policy of the corresponding dds::sub::DataReader. More...
const dds::core::policy::Deadline &	deadline () const
	Get the dds::core::policy::Deadline policy of the corresponding dds::sub::DataReader. More...
const dds::core::policy::LatencyBudget &	latency_budget () const
	Get the dds::core::policy::LatencyBudget policy of the corresponding dds::sub::DataReader. More...
const dds::core::policy::Liveliness &	liveliness () const
	Get the dds::core::policy::Liveliness policy of the corresponding dds::sub::DataReader. More...
const dds::core::policy::Reliability &	reliability () const
	Get the dds::core::policy::Reliability policy of the corresponding dds::sub::DataReader. More...
const dds::core::policy::Ownership &	ownership () const
	Get the dds::core::policy::Ownership policy of the corresponding dds::sub::DataReader. More...
const dds::core::policy::DestinationOrder &	destination_order () const
	Get the dds::core::policy::DestinationOrder policy of the corresponding dds::sub::DataReader. More...
const dds::core::policy::UserData &	user_data () const
	Get the dds::core::policy::UserData policy of the corresponding dds::sub::DataReader. More...
const dds::core::policy::TimeBasedFilter &	time_based_filter () const
	Get the dds::core::policy::TimeBasedFilter policy of the corresponding dds::sub::DataReader. More...
const dds::core::policy::Presentation &	presentation () const
	Get the dds::core::policy::Presentation policy of the corresponding dds::sub::DataReader. More...
const dds::core::policy::Partition &	partition () const
	Get the dds::core::policy::TopicData policy of the corresponding dds::sub::DataReader. More...
const dds::core::policy::TopicData &	topic_data () const
	Get the dds::core::policy::TopicData policy of the related dds::topic::Topic. More...
const dds::core::policy::GroupData &	group_data () const
	Get the dds::core::policy::GroupData policy of the dds::sub::Subscriber to which the dds::sub::DataReader belongs. More...
const dds::core::policy::DataRepresentation &	representation () const
	Get the dds::core::policy::DataRepresentation policy of the corresponding dds::sub::DataReader. More...
const dds::core::policy::DataTag &	data_tag () const
	Get the dds::core::policy::DataTag policy of the corresponding dds::sub::DataReader. More...
dds::core::optional< dds::core::xtypes::DynamicType >	type () const
	<<extension>> Get the type More...
const dds::core::optional< dds::core::xtypes::DynamicType > &	get_type_no_copy () const
	<<extension>> Get the type by reference if possible More...
const dds::topic::BuiltinTopicKey &	subscriber_key () const
	<<extension>> Get the DCPS key of the subscriber to which the DataReader belongs. More...
const rti::core::policy::Property &	property () const
	<<extension>> Get the Property policy of the corresponding DataReader More...
const dds::core::vector< rti::core::Locator > &	unicast_locators () const
	<<extension>> Get the custom unicast locators that the endpoint can specify. The default locators will be used if this is not specified. More...
const dds::core::vector< rti::core::Locator > &	multicast_locators () const
	<<extension>> Get the custom multicast locators that the endpoint can specify. The default locators will be used if this is not specified. More...
const rti::core::ContentFilterProperty &	content_filter_property () const
	<<extension>> This provides all the required information to enable content filtering on the Writer side. More...
const rti::core::Guid &	virtual_guid () const
	<<extension>> Gets the virtual GUID associated to the DataReader. More...
const rti::core::ProtocolVersion &	rtps_protocol_version () const
	<<extension>> Get the version of the RTPS wire protocol used. More...
const rti::core::VendorId &	rtps_vendor_id () const
	<<extension>> Get the ID of vendor implementing the RTPS wire protocol More...
const rti::core::ProductVersion &	product_version () const
	<<extension>> Gets the version of RTI Connext More...
bool	disable_positive_acks () const
	<<extension>> Get whether or not the corresponding dds::sub::DataReader sends positive acknowledgments for reliability. More...
const rti::core::policy::EntityName &	subscription_name () const
	<<extension>> Get the subscription name and role name. More...
const rti::topic::trust::EndpointTrustInfo &	trust_info () const
	<<extension>> Get the Trust Plugins information associated with the discovered DataReader. More...
const rti::topic::trust::EndpointTrustAlgorithms &	trust_algorithms () const
	<<extension>> Get the Trust plugins algorithms associated with the discovered DataReader. More...
const rti::core::policy::Service &	service () const
	<<extension>> Get the Service policy of the corresponding DataReader. More...

Detailed Description

Entry created when a dds::sub::DataReader is discovered in association with its dds::sub::Subscriber.

Data associated with the built-in topic dds::topic::subscription_topic_name(). It contains QoS policies and additional information that apply to the remote dds::sub::DataReader the related dds::sub::Subscriber.

Member Function Documentation

TSubscriptionBuiltinTopicData()

dds::topic::SubscriptionBuiltinTopicData::TSubscriptionBuiltinTopicData ( )

inline

Create a default SubscriptionBuiltinTopicData.

key()

const dds::topic::BuiltinTopicKey& dds::topic::SubscriptionBuiltinTopicData::key ( ) const

inline

Get the DCPS key to distinguish entries.

Returns

The key

participant_key()

const dds::topic::BuiltinTopicKey& dds::topic::SubscriptionBuiltinTopicData::participant_key ( ) const

inline

Get the DCPS key of the dds::domain::DomainParticipant to which the dds::sub::DataReader belongs.

Returns

The DomainParticipant's key

topic_name()

const dds::core::string& dds::topic::SubscriptionBuiltinTopicData::topic_name ( ) const

inline

Get the name of the related dds::topic::Topic.

Returns

The topic name

type_name()

const dds::core::string& dds::topic::SubscriptionBuiltinTopicData::type_name ( ) const

inline

Get the name of the type attached to the dds::topic::Topic.

Returns

The type name

durability()

const dds::core::policy::Durability& dds::topic::SubscriptionBuiltinTopicData::durability ( ) const

inline

Get the dds::core::policy::Durability policy of the corresponding dds::sub::DataReader.

Returns

The Durability policy

deadline()

const dds::core::policy::Deadline& dds::topic::SubscriptionBuiltinTopicData::deadline ( ) const

inline

Get the dds::core::policy::Deadline policy of the corresponding dds::sub::DataReader.

Returns

The Deadline policy

latency_budget()

const dds::core::policy::LatencyBudget& dds::topic::SubscriptionBuiltinTopicData::latency_budget ( ) const

inline

Get the dds::core::policy::LatencyBudget policy of the corresponding dds::sub::DataReader.

Returns

The LatencyBudget policy

liveliness()

const dds::core::policy::Liveliness& dds::topic::SubscriptionBuiltinTopicData::liveliness ( ) const

inline

Get the dds::core::policy::Liveliness policy of the corresponding dds::sub::DataReader.

Returns

The Liveliness policy

reliability()

const dds::core::policy::Reliability& dds::topic::SubscriptionBuiltinTopicData::reliability ( ) const

inline

Get the dds::core::policy::Reliability policy of the corresponding dds::sub::DataReader.

Returns

The Reliability policy

ownership()

const dds::core::policy::Ownership& dds::topic::SubscriptionBuiltinTopicData::ownership ( ) const

inline

Get the dds::core::policy::Ownership policy of the corresponding dds::sub::DataReader.

Returns

The Ownership policy

destination_order()

const dds::core::policy::DestinationOrder& dds::topic::SubscriptionBuiltinTopicData::destination_order ( ) const

inline

Get the dds::core::policy::DestinationOrder policy of the corresponding dds::sub::DataReader.

Returns

The DestinationOrder policy

user_data()

const dds::core::policy::UserData& dds::topic::SubscriptionBuiltinTopicData::user_data ( ) const

inline

Get the dds::core::policy::UserData policy of the corresponding dds::sub::DataReader.

Returns

The UserData policy

time_based_filter()

const dds::core::policy::TimeBasedFilter& dds::topic::SubscriptionBuiltinTopicData::time_based_filter ( ) const

inline

Get the dds::core::policy::TimeBasedFilter policy of the corresponding dds::sub::DataReader.

Returns

The TimeBasedFilter policy

presentation()

const dds::core::policy::Presentation& dds::topic::SubscriptionBuiltinTopicData::presentation ( ) const

inline

Get the dds::core::policy::Presentation policy of the corresponding dds::sub::DataReader.

Returns

The Presentation policy

partition()

const dds::core::policy::Partition& dds::topic::SubscriptionBuiltinTopicData::partition ( ) const

inline

Get the dds::core::policy::TopicData policy of the corresponding dds::sub::DataReader.

Returns

The TopicData policy

topic_data()

const dds::core::policy::TopicData& dds::topic::SubscriptionBuiltinTopicData::topic_data ( ) const

inline

Get the dds::core::policy::TopicData policy of the related dds::topic::Topic.

Returns

The TopicData policy

group_data()

const dds::core::policy::GroupData& dds::topic::SubscriptionBuiltinTopicData::group_data ( ) const

inline

Get the dds::core::policy::GroupData policy of the dds::sub::Subscriber to which the dds::sub::DataReader belongs.

Returns

The GroupData policy

representation()

const dds::core::policy::DataRepresentation& dds::topic::SubscriptionBuiltinTopicData::representation ( ) const

inline

Get the dds::core::policy::DataRepresentation policy of the corresponding dds::sub::DataReader.

Returns

The DataRepresentation policy

data_tag()

const dds::core::policy::DataTag& dds::topic::SubscriptionBuiltinTopicData::data_tag ( ) const

inline

Get the dds::core::policy::DataTag policy of the corresponding dds::sub::DataReader.

Returns

The DataTag policy

type()

dds::core::optional< dds::core::xtypes::DynamicType > type

(

)

const

<<extension>> Get the type

Note

This is not a lightweight getter–obtaining the type may require some processing so it is recommended that you keep the value if you need to use it multiple times rather than look it up every time. See also get_type_no_copy().

Returns

The type or an unset optional value if the type is not available

get_type_no_copy()

const dds::core::optional< dds::core::xtypes::DynamicType > & get_type_no_copy

(

)

const

<<extension>> Get the type by reference if possible

Exceptions

dds::core::PreconditionNotMet

If the type is available but is not in a format that is directly accessible. In that case it needs some extra processing and has to be accessed using type(). You can also ensure that it is in the right format by setting rti::core::policy::DomainParticipantResourceLimits::type_code_max_serialized_length() to 0.

Returns

The type or an unset optional value if the type is not available

See also

type()

subscriber_key()

const dds::topic::BuiltinTopicKey & subscriber_key

(

)

const

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

property()

const rti::core::policy::Property & property

(

)

const

<<extension>> Get the Property policy of the corresponding DataReader

Returns

unicast_locators()

const dds::core::vector< rti::core::Locator > & unicast_locators

(

)

const

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

multicast_locators()

const dds::core::vector< rti::core::Locator > & multicast_locators

(

)

const

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

content_filter_property()

const rti::core::ContentFilterProperty & content_filter_property

(

)

const

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

virtual_guid()

const rti::core::Guid & virtual_guid

(

)

const

<<extension>> Gets the virtual GUID associated to the DataReader.

rtps_protocol_version()

const rti::core::ProtocolVersion & rtps_protocol_version

(

)

const

<<extension>> Get the version of the RTPS wire protocol used.

rtps_vendor_id()

const rti::core::VendorId & rtps_vendor_id

(

)

const

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

product_version()

const rti::core::ProductVersion & product_version

(

)

const

<<extension>> Gets the version of RTI Connext

Returns

disable_positive_acks()

bool disable_positive_acks

(

)

const

<<extension>> Get whether or not the corresponding dds::sub::DataReader sends positive acknowledgments for reliability.

Returns

false if positive acknowledgments are disabled, true otherwise

subscription_name()

const rti::core::policy::EntityName & subscription_name

(

)

const

<<extension>> Get the subscription name and role name.

trust_info()

const rti::topic::trust::EndpointTrustInfo & trust_info

(

)

const

<<extension>> Get the Trust Plugins 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_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_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_algorithms()

const rti::topic::trust::EndpointTrustAlgorithms & trust_algorithms

(

)

const

<<extension>> Get the 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_algorithms contains information about what algorithms the loaded Trust Plugins are running. Two endpoints will not match if their trust_algorithms 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.

service()

const rti::core::policy::Service & service

(

)

const

<<extension>> Get the Service policy of the corresponding DataReader.