RTI Connext C# API  6.1.0
SubscriptionBuiltinTopicData Class Reference

Entry created when a Subscription.DataReader<T> is discovered in association with its Subscription.Subscriber. More...

Inherits IEquatable< SubscriptionBuiltinTopicData >.

Public Member Functions

 SubscriptionBuiltinTopicData (in BuiltinTopicKey key)
 Creates a new SubscriptionBuiltinTopicData using a BuiltinTopicKey. More...
 
override int GetHashCode ()
 Gets the hash code More...
 
override bool Equals (object other)
 Compares for equality More...
 
bool Equals (SubscriptionBuiltinTopicData 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...
 
BuiltinTopicKey ParticipantKey [get]
 DCPS key of the participant to which the DataReader belongs. More...
 
string TopicName [get]
 Name of the related Topics.Topic<T>. More...
 
string TypeName [get]
 Name of the type attached to the Topics.Topic<T>. More...
 
Durability Durability [get]
 Policy of the corresponding DataReader More...
 
Deadline Deadline [get]
 Policy of the corresponding DataReader More...
 
LatencyBudget LatencyBudget [get]
 Policy of the corresponding DataReader More...
 
Liveliness Liveliness [get]
 Policy of the corresponding DataReader More...
 
Reliability Reliability [get]
 Policy of the corresponding DataReader More...
 
Ownership Ownership [get]
 Policy of the corresponding DataReader More...
 
DestinationOrder DestinationOrder [get]
 Policy of the corresponding DataReader More...
 
UserData UserData [get]
 Policy of the corresponding DataReader More...
 
TimeBasedFilter TimeBasedFilter [get]
 Policy of the corresponding DataReader More...
 
Presentation Presentation [get]
 Policy of the Subscriber to which the DataReader belongs More...
 
Partition Partition [get]
 Policy of the Subscriber to which the DataReader belongs More...
 
TopicData TopicData [get]
 Policy of the related Topic More...
 
GroupData GroupData [get]
 Policy of the Subscriber to which the DataReader belongs More...
 
TypeConsistencyEnforcement TypeConsistency [get]
 Policy of the corresponding DataReader More...
 
DataRepresentation Representation [get]
 Data representation policy of the corresponding DataReader More...
 
DataTags DataTags [get]
 Tags of the corresponding DataReader More...
 
DynamicType DynamicType [get]
 Type code information of the corresponding Topic More...
 
BuiltinTopicKey SubscriberKey [get]
 DCPS key of the subscriber to which the DataReader belongs. More...
 
Property Property [get]
 Properties of the corresponding DataReader. More...
 
ImmutableList< LocatorUnicastLocators [get]
 Custom unicast locators that the endpoint can specify. The default locators will be used if this is not specified. More...
 
ImmutableList< LocatorMulticastLocators [get]
 Custom multicast locators that the endpoint can specify. The default locators will be used if this is not specified. More...
 
ContentFilterProperty ContentFilterProperty [get]
 This field provides all the required information to enable content filtering on the Writer side. More...
 
Core.Guid VirtualGuid [get]
 Virtual GUID associated with the DataReader. More...
 
Service Service [get]
 Policy of the corresponding DataReader. 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...
 
Version ProductVersion [get]
 This is a vendor specific parameter. It gives the current version of RTI Connext More...
 
bool DisablePositiveAcks [get]
 This is a vendor specific parameter. Determines whether the corresponding DataReader sends positive acknowledgments for reliability. More...
 
EntityName SubscriptionName [get]
 The subscription name and role name. More...
 

Detailed Description

Entry created when a Subscription.DataReader<T> is discovered in association with its Subscription.Subscriber.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData

Constructor & Destructor Documentation

◆ SubscriptionBuiltinTopicData()

Creates a new SubscriptionBuiltinTopicData 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 ( SubscriptionBuiltinTopicData  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

◆ ContentFilterProperty

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

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::content_filter_property

◆ DataTags

Tags of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::data_tags

◆ Deadline

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::deadline

◆ DestinationOrder

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::destination_order

◆ DisablePositiveAcks

bool DisablePositiveAcks
get

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

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::disable_positive_acks

◆ Durability

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::durability

◆ DynamicType

Type code information of the corresponding Topic

The type information if available, or null if it's not available

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::type_code

◆ GroupData

Policy of the Subscriber to which the DataReader belongs

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::group_data

◆ Key

BuiltinTopicKey Key
get

DCPS key to distinguish entries

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

◆ LatencyBudget

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::latency_budget

◆ Liveliness

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::liveliness

◆ MulticastLocators

ImmutableList<Locator> MulticastLocators
get

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

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::multicast_locators

◆ Ownership

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::ownership

◆ ParticipantKey

BuiltinTopicKey ParticipantKey
get

DCPS key of the participant to which the DataReader belongs.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::participant_key

◆ Partition

Policy of the Subscriber to which the DataReader belongs

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::partition

◆ Presentation

Policy of the Subscriber to which the DataReader belongs

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::presentation

◆ ProductVersion

Version ProductVersion
get

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

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

◆ Property

Properties of the corresponding DataReader.

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

◆ Reliability

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::reliability

◆ Representation

DataRepresentation Representation
get

Data representation policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::representation

◆ RtpsProtocolVersion

Version RtpsProtocolVersion
get

Version number of the RTPS wire protocol used.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::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_SubscriptionBuiltinTopicData::rtps_vendor_id

◆ Service

Policy of the corresponding DataReader.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::service

◆ SubscriberKey

BuiltinTopicKey SubscriberKey
get

DCPS key of the subscriber to which the DataReader belongs.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::subscriber_key

◆ SubscriptionName

EntityName SubscriptionName
get

The subscription name and role name.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::subscription_name

◆ TimeBasedFilter

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::time_based_filter

◆ TopicData

Policy of the related Topic

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::topic_data

◆ TopicName

string TopicName
get

Name of the related Topics.Topic<T>.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::topic_name

◆ TypeConsistency

TypeConsistencyEnforcement TypeConsistency
get

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::type_consistency

◆ TypeName

string TypeName
get

Name of the type attached to the Topics.Topic<T>.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::type_name

◆ UnicastLocators

ImmutableList<Locator> UnicastLocators
get

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

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::unicast_locators

◆ UserData

Policy of the corresponding DataReader

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

◆ VirtualGuid

Core.Guid VirtualGuid
get

Virtual GUID associated with the DataReader.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData::virtual_guid