RTI Connext C# API  6.1.0
ParticipantBuiltinTopicData Class Reference

Entry created when a Domain.DomainParticipant is discovered. More...

Inherits IEquatable< ParticipantBuiltinTopicData >.

Public Member Functions

 ParticipantBuiltinTopicData (in BuiltinTopicKey key)
 Creates a new ParticipantBuiltinTopicData using a BuiltinTopicKey. More...
 
override int GetHashCode ()
 Gets the hash code More...
 
override bool Equals (object other)
 Compares for equality More...
 
bool Equals (ParticipantBuiltinTopicData other)
 Compares for equality More...
 
override string ToString ()
 Returns a readable summary of the data More...
 

Properties

BuiltinTopicKey Key [get]
 DCPS key to distinguish entries. More...
 
UserData UserData [get]
 Policy of the corresponding DomainParticipant. More...
 
Property Property [get]
 Name value pair properties to be stored with domain participant More...
 
Version RtpsProtocolVersion [get]
 Version number of the RTPS wire protocol used. More...
 
VendorId RtpsVendorId [get]
 ID of vendor implementing the RTPS wire protocol. More...
 
uint DdsBuiltinEndpoints [get]
 Bitmap of builtin endpoints supported by the participant. More...
 
ImmutableList< LocatorDefaultUnicastLocators [get]
 Unicast locators used when individual entities do not specify unicast locators. More...
 
Version ProductVersion [get]
 This is a vendor specific parameter. It gives the current version for rti-dds. More...
 
EntityName ParticipantName [get]
 The participant name and role name. More...
 
int DomainId [get]
 Domain ID associated with the discovered participant. More...
 
ImmutableList< TransportInfoTransportInfos [get]
 A sequence of TransportInfo containing information about each of the installed transports of the discovered participant. More...
 
Duration ReachabilityLeaseDuration [get]
 Locator reachability lease duration. More...
 
static ParticipantBuiltinTopicData Default [get]
 Singleton containing the default value of a ParticipantBuiltinTopicData More...
 

Detailed Description

Entry created when a Domain.DomainParticipant is discovered.

The full documentation is available in the C API: DDS_ParticipantBuiltinTopicData

Constructor & Destructor Documentation

◆ ParticipantBuiltinTopicData()

Creates a new ParticipantBuiltinTopicData using a BuiltinTopicKey.

The rest of elements are not initialized. This constructor can be used to create a key holder for Subscription.DataReader<T>.LookupInstance(T).

Member Function Documentation

◆ Equals() [1/2]

override bool Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Equals ( ParticipantBuiltinTopicData  other)

Compares for equality

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code

◆ ToString()

override string ToString ( )

Returns a readable summary of the data

Property Documentation

◆ DdsBuiltinEndpoints

uint DdsBuiltinEndpoints
get

Bitmap of builtin endpoints supported by the participant.

The full documentation is available in the C API: DDS_ParticipantBuiltinTopicData::dds_builtin_endpoints

◆ Default

ParticipantBuiltinTopicData Default
staticget

Singleton containing the default value of a ParticipantBuiltinTopicData

◆ DefaultUnicastLocators

ImmutableList<Locator> DefaultUnicastLocators
get

Unicast locators used when individual entities do not specify unicast locators.

The full documentation is available in the C API: DDS_ParticipantBuiltinTopicData::default_unicast_locators

◆ DomainId

int DomainId
get

Domain ID associated with the discovered participant.

The full documentation is available in the C API: DDS_ParticipantBuiltinTopicData::domain_id

◆ Key

BuiltinTopicKey Key
get

DCPS key to distinguish entries.

The full documentation is available in the C API: DDS_ParticipantBuiltinTopicData::key

◆ ParticipantName

EntityName ParticipantName
get

The participant name and role name.

The full documentation is available in the C API: DDS_ParticipantBuiltinTopicData::participant_name

◆ ProductVersion

Version ProductVersion
get

This is a vendor specific parameter. It gives the current version for rti-dds.

The full documentation is available in the C API: DDS_ParticipantBuiltinTopicData::product_version

◆ Property

Name value pair properties to be stored with domain participant

The full documentation is available in the C API: DDS_ParticipantBuiltinTopicData::property

◆ ReachabilityLeaseDuration

Duration ReachabilityLeaseDuration
get

Locator reachability lease duration.

The full documentation is available in the C API: DDS_ParticipantBuiltinTopicData::reachability_lease_duration

◆ RtpsProtocolVersion

Version RtpsProtocolVersion
get

Version number of the RTPS wire protocol used.

The full documentation is available in the C API: DDS_ParticipantBuiltinTopicData::rtps_protocol_version

◆ RtpsVendorId

VendorId RtpsVendorId
get

ID of vendor implementing the RTPS wire protocol.

The full documentation is available in the C API: DDS_ParticipantBuiltinTopicData::rtps_vendor_id

◆ TransportInfos

ImmutableList<TransportInfo> TransportInfos
get

A sequence of TransportInfo containing information about each of the installed transports of the discovered participant.

The full documentation is available in the C API: DDS_ParticipantBuiltinTopicData::transport_info

◆ UserData

Policy of the corresponding DomainParticipant.

The full documentation is available in the C API: DDS_ParticipantBuiltinTopicData::user_data