RTI Connext Modern C++ API  Version 5.2.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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.
 
const dds::topic::BuiltinTopicKeykey () const
 Get the DCPS key to distinguish entries.
 
const dds::topic::BuiltinTopicKeyparticipant_key () const
 Get the DCPS key of the dds::domain::DomainParticipant to which the dds::sub::DataReader belongs.
 
const dds::core::stringtopic_name () const
 Get the name of the related dds::topic::Topic.
 
const dds::core::stringtype_name () const
 Get the name of the type attached to the dds::topic::Topic.
 
const
dds::core::policy::Durability
durability () const
 Get the dds::core::policy::Durability policy of the corresponding dds::sub::DataReader.
 
const dds::core::policy::Deadlinedeadline () const
 Get the dds::core::policy::Deadline policy of the corresponding dds::sub::DataReader.
 
const
dds::core::policy::LatencyBudget
latency_budget () const
 Get the dds::core::policy::LatencyBudget policy of the corresponding dds::sub::DataReader.
 
const
dds::core::policy::Liveliness
liveliness () const
 Get the dds::core::policy::Liveliness policy of the corresponding dds::sub::DataReader.
 
const
dds::core::policy::Reliability
reliability () const
 Get the dds::core::policy::Reliability policy of the corresponding dds::sub::DataReader.
 
const
dds::core::policy::Ownership
ownership () const
 Get the dds::core::policy::Ownership policy of the corresponding dds::sub::DataReader.
 
const
dds::core::policy::DestinationOrder
destination_order () const
 Get the dds::core::policy::DestinationOrder policy of the corresponding dds::sub::DataReader.
 
const dds::core::policy::UserDatauser_data () const
 Get the dds::core::policy::UserData policy of the corresponding dds::sub::DataReader.
 
const
dds::core::policy::TimeBasedFilter
time_based_filter () const
 Get the dds::core::policy::TimeBasedFilter policy of the corresponding dds::sub::DataReader.
 
const
dds::core::policy::Presentation
presentation () const
 Get the dds::core::policy::Presentation policy of the corresponding dds::sub::DataReader.
 
const
dds::core::policy::Partition
partition () const
 Get the dds::core::policy::TopicData policy of the corresponding dds::sub::DataReader.
 
const
dds::core::policy::TopicData
topic_data () const
 Get the dds::core::policy::TopicData policy of the related dds::topic::Topic.
 
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.
 
dds::core::optional
< dds::core::xtypes::DynamicType
type () const
 <<extension>> Get the type
 
const dds::core::optional
< dds::core::xtypes::DynamicType > & 
get_type_no_copy () const
 <<extension>> Get the type by reference if possible
 
const dds::topic::BuiltinTopicKeysubscriber_key () const
 <<extension>> Get the DCPS key of the subscriber to which the DataReader belongs.
 
const rti::core::policy::Propertyproperty () const
 <<extension>> Get the Property policy of the corresponding DataReader
 
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.
 
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.
 
const
rti::core::ContentFilterProperty
content_filter_property () const
 <<extension>> This provides all the required information to enable content filtering on the Writer side.
 
const rti::core::Guidvirtual_guid () const
 <<extension>> Gets the virtual GUID associated to the DataReader.
 
const rti::core::ProtocolVersionrtps_protocol_version () const
 <<extension>> Get the version of the RTPS wire protocol used.
 
const rti::core::VendorIdrtps_vendor_id () const
 <<extension>> Get the ID of vendor implementing the RTPS wire protocol
 
const rti::core::ProductVersionproduct_version () const
 <<extension>> Gets the version of RTI Connext
 
bool disable_positive_acks () const
 <<extension>> Get whether or not the corresponding dds::sub::DataReader sends positive acknowledgments for reliability.
 
const
rti::core::policy::EntityName
subscription_name () const
 <<extension>> Get the subscription name and role name.
 
const rti::core::policy::Serviceservice () const
 <<extension>> Get the Service policy of the corresponding DataReader.
 

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

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

Create a default SubscriptionBuiltinTopicData.

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

Get the DCPS key to distinguish entries.

Returns
The 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
const dds::core::string& dds::topic::SubscriptionBuiltinTopicData::topic_name ( ) const
inline

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

Returns
The topic 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
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
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
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
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
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
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
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
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
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
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
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
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
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

<<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
const dds::core::optional< dds::core::xtypes::DynamicType > & get_type_no_copy ( ) const

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

Exceptions
dds::core::PreconditionNotMetIf 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()
const dds::topic::BuiltinTopicKey & subscriber_key ( ) const

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

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

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

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

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.

const rti::core::ContentFilterProperty & content_filter_property ( ) const

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

const rti::core::Guid & virtual_guid ( ) const

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

const rti::core::ProtocolVersion & rtps_protocol_version ( ) const

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

const rti::core::VendorId & rtps_vendor_id ( ) const

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

const rti::core::ProductVersion & product_version ( ) const

<<extension>> Gets the version of RTI Connext

Returns
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
const rti::core::policy::EntityName & subscription_name ( ) const

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

Examples:
USER_QOS_PROFILES.xml.
const rti::core::policy::Service & service ( ) const

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


RTI Connext Modern C++ API Version 5.2.0 Copyright © Sun Jun 21 2015 Real-Time Innovations, Inc