RTI Connext Modern C++ API  Version 6.1.2
dds::topic::ParticipantBuiltinTopicData Class Reference

Entry created when a dds::domain::DomainParticipant is discovered. More...

#include <dds/topic/BuiltinTopic.hpp>

Public Member Functions

 TParticipantBuiltinTopicData ()
 Create a default ParticipantBuiltinTopicData. More...
 
const dds::topic::BuiltinTopicKeykey () const
 Get the DCPS key to distinguish entries. More...
 
const dds::core::policy::UserDatauser_data () const
 Get the dds::core::policy::UserData policy of the corresponding dds::domain::DomainParticipant. More...
 
const rti::core::policy::Propertyproperty () const
 <<extension>> Get the name-value pair properties to be stored with dds::domin::DomainParticipant More...
 
const rti::core::ProtocolVersionrtps_protocol_version () const
 <<extension>> Get the version number of the RTPS wire protocol used. More...
 
const rti::core::VendorIdrtps_vendor_id () const
 <<extension>> Get the ID of the vendor implementing the RTPS wire protocol. More...
 
uint32_t dds_builtin_endpoints () const
 <<extension>> Bitmap of builtin endpoints supported by the participant More...
 
const dds::core::vector< rti::core::Locator > & default_unicast_locators () const
 <<extension>> Get the unicast locators used when individual entities do not specify unicast locators. More...
 
const rti::core::ProductVersionproduct_version () const
 <<extension>> Get the current version for RTI Connext. More...
 
const rti::core::policy::EntityNameparticipant_name () const
 <<extension>> Get the participant name and role name. More...
 
int32_t domain_id () const
 <<extension>> Get the domain ID associated with the discovered dds::domain::DomainParticipant. More...
 
const rti::core::TransportInfoSeqtransport_info () const
 <<extension>> Get the sequence of rti::core::TransportInfo containing information about each of the installed transports of the discovered dds::domain::DomainParticipant. More...
 
const dds::core::Durationreachability_lease_duration () const
 <<extension>> Get the reachability lease duration. More...
 
uint32_t vendor_builtin_endpoints () const
 <<extension>> Bitmap of vendor-specific builtin endpoints supported by the participant More...
 

Detailed Description

Entry created when a dds::domain::DomainParticipant is discovered.

Member Function Documentation

◆ TParticipantBuiltinTopicData()

dds::topic::ParticipantBuiltinTopicData::TParticipantBuiltinTopicData ( )
inline

◆ key()

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

Get the DCPS key to distinguish entries.

Returns
The key

◆ user_data()

const dds::core::policy::UserData& dds::topic::ParticipantBuiltinTopicData::user_data ( ) const
inline

Get the dds::core::policy::UserData policy of the corresponding dds::domain::DomainParticipant.

Returns
The UserData policy

◆ property()

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

<<extension>> Get the name-value pair properties to be stored with dds::domin::DomainParticipant

Returns
The name-value pair properties that were propagated from the corresponding dds::domain::DomainParticipant

◆ rtps_protocol_version()

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

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

Returns
The protocol version.

◆ rtps_vendor_id()

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

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

Returns
The vendor id.

◆ dds_builtin_endpoints()

uint32_t dds_builtin_endpoints ( ) const

<<extension>> Bitmap of builtin endpoints supported by the participant

Each bit indicates a builtin endpoint that may be available on the participant for use in discovery.

◆ default_unicast_locators()

const dds::core::vector< rti::core::Locator > & default_unicast_locators ( ) const

<<extension>> Get the unicast locators used when individual entities do not specify unicast locators.

Returns
A sequence of the default unicast locators used

◆ product_version()

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

<<extension>> Get the current version for RTI Connext.

Returns
The RTI Connext version being used

◆ participant_name()

const rti::core::policy::EntityName & participant_name ( ) const

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

Returns
The rti::core::policy::EntityName QoS policy for the corresponding dds::domain::DomainParticipant.

◆ domain_id()

int32_t domain_id ( ) const

<<extension>> Get the domain ID associated with the discovered dds::domain::DomainParticipant.

Returns
The domain id
Examples:
Foo_publisher.cxx, and Foo_subscriber.cxx.

◆ transport_info()

const rti::core::TransportInfoSeq & transport_info ( ) const

<<extension>> Get the sequence of rti::core::TransportInfo containing information about each of the installed transports of the discovered dds::domain::DomainParticipant.

This parameter contains a sequence of rti::core::TransportInfo containing the class_id and message_size_max for all installed transports of the discovered participant. The maximum number of rti::core::TransportInfo that will be stored in this sequence is controlled by the DomainParticipant's resource limit rti::core::policy::DomainParticipantResourceLimits::transport_info_list_max_length.

Returns
The sequence of transport infos

◆ reachability_lease_duration()

const dds::core::Duration & reachability_lease_duration ( ) const

<<extension>> Get the reachability lease duration.

◆ vendor_builtin_endpoints()

uint32_t vendor_builtin_endpoints ( ) const

<<extension>> Bitmap of vendor-specific builtin endpoints supported by the participant