RTI Connext C# API Version 7.2.0
Rti.Dds.Topics.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()

Rti.Dds.Topics.SubscriptionBuiltinTopicData.SubscriptionBuiltinTopicData ( in BuiltinTopicKey  key)

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

◆ GetHashCode()

override int Rti.Dds.Topics.SubscriptionBuiltinTopicData.GetHashCode ( )

Gets the hash code

◆ Equals() [1/2]

override bool Rti.Dds.Topics.SubscriptionBuiltinTopicData.Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Rti.Dds.Topics.SubscriptionBuiltinTopicData.Equals ( SubscriptionBuiltinTopicData  other)
inline

Compares for equality

◆ ToString()

override string Rti.Dds.Topics.SubscriptionBuiltinTopicData.ToString ( )
inline

Returns a readable summary of the data

Property Documentation

◆ Key

BuiltinTopicKey Rti.Dds.Topics.SubscriptionBuiltinTopicData.Key
get

DCPS key to distinguish entries

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_key

◆ ParticipantKey

BuiltinTopicKey Rti.Dds.Topics.SubscriptionBuiltinTopicData.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

◆ TopicName

string Rti.Dds.Topics.SubscriptionBuiltinTopicData.TopicName
get

Name of the related Topics.Topic<T>.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_topic_name

◆ TypeName

string Rti.Dds.Topics.SubscriptionBuiltinTopicData.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

◆ Durability

Durability Rti.Dds.Topics.SubscriptionBuiltinTopicData.Durability
get

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_durability

◆ Deadline

Deadline Rti.Dds.Topics.SubscriptionBuiltinTopicData.Deadline
get

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_deadline

◆ LatencyBudget

LatencyBudget Rti.Dds.Topics.SubscriptionBuiltinTopicData.LatencyBudget
get

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_latency_budget

◆ Liveliness

Liveliness Rti.Dds.Topics.SubscriptionBuiltinTopicData.Liveliness
get

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_liveliness

◆ Reliability

Reliability Rti.Dds.Topics.SubscriptionBuiltinTopicData.Reliability
get

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_reliability

◆ Ownership

Ownership Rti.Dds.Topics.SubscriptionBuiltinTopicData.Ownership
get

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_ownership

◆ DestinationOrder

DestinationOrder Rti.Dds.Topics.SubscriptionBuiltinTopicData.DestinationOrder
get

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_destination_order

◆ UserData

UserData Rti.Dds.Topics.SubscriptionBuiltinTopicData.UserData
get

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_user_data

◆ TimeBasedFilter

TimeBasedFilter Rti.Dds.Topics.SubscriptionBuiltinTopicData.TimeBasedFilter
get

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_time_based_filter

◆ Presentation

Presentation Rti.Dds.Topics.SubscriptionBuiltinTopicData.Presentation
get

Policy of the Subscriber to which the DataReader belongs

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_presentation

◆ Partition

Partition Rti.Dds.Topics.SubscriptionBuiltinTopicData.Partition
get

Policy of the Subscriber to which the DataReader belongs

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_partition

◆ TopicData

TopicData Rti.Dds.Topics.SubscriptionBuiltinTopicData.TopicData
get

Policy of the related Topic

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_topic_data

◆ GroupData

GroupData Rti.Dds.Topics.SubscriptionBuiltinTopicData.GroupData
get

Policy of the Subscriber to which the DataReader belongs

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_group_data

◆ TypeConsistency

TypeConsistencyEnforcement Rti.Dds.Topics.SubscriptionBuiltinTopicData.TypeConsistency
get

Policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_type_consistency

◆ Representation

DataRepresentation Rti.Dds.Topics.SubscriptionBuiltinTopicData.Representation
get

Data representation policy of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_representation

◆ DataTags

DataTags Rti.Dds.Topics.SubscriptionBuiltinTopicData.DataTags
get

Tags of the corresponding DataReader

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_data_tags

◆ DynamicType

DynamicType Rti.Dds.Topics.SubscriptionBuiltinTopicData.DynamicType
get

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

◆ SubscriberKey

BuiltinTopicKey Rti.Dds.Topics.SubscriptionBuiltinTopicData.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

◆ Property

Property Rti.Dds.Topics.SubscriptionBuiltinTopicData.Property
get

Properties of the corresponding DataReader.

The full documentation is available in the C API: property_qos

◆ UnicastLocators

ImmutableList<Locator> Rti.Dds.Topics.SubscriptionBuiltinTopicData.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

◆ MulticastLocators

ImmutableList<Locator> Rti.Dds.Topics.SubscriptionBuiltinTopicData.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

◆ ContentFilterProperty

ContentFilterProperty Rti.Dds.Topics.SubscriptionBuiltinTopicData.ContentFilterProperty
get

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

◆ VirtualGuid

Core.Guid Rti.Dds.Topics.SubscriptionBuiltinTopicData.VirtualGuid
get

Virtual GUID associated with the DataReader.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_virtual_guid

◆ Service

Service Rti.Dds.Topics.SubscriptionBuiltinTopicData.Service
get

Policy of the corresponding DataReader.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_service

◆ RtpsProtocolVersion

Version Rti.Dds.Topics.SubscriptionBuiltinTopicData.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 Rti.Dds.Topics.SubscriptionBuiltinTopicData.RtpsVendorId
get

ID of vendor implementing the RTPS wire protocol.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_rtps_vendor_id

◆ ProductVersion

Version Rti.Dds.Topics.SubscriptionBuiltinTopicData.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

◆ DisablePositiveAcks

bool Rti.Dds.Topics.SubscriptionBuiltinTopicData.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

◆ SubscriptionName

EntityName Rti.Dds.Topics.SubscriptionBuiltinTopicData.SubscriptionName
get

The subscription name and role name.

The full documentation is available in the C API: DDS_SubscriptionBuiltinTopicData_subscription_name