RTI Connext C# API Version 7.2.0
Rti.Dds.Core.Status.SubscriptionMatchedStatus Class Reference

Indicates that the Subscription.DataReader<T> discovered a matching Publication.DataWriter<T>. More...

Inherits IEquatable< SubscriptionMatchedStatus >.

Public Member Functions

override int GetHashCode ()
 Gets the hash code. More...
 
override bool Equals (object other)
 Compares for equality. More...
 
bool Equals (SubscriptionMatchedStatus other)
 Compares for equality. More...
 
override string ToString ()
 Returns a readable summary of the status More...
 

Properties

EventCount< int > TotalCount [get]
 The total cumulative number of times that this DataReader discovered a "match" with a DataWriter. More...
 
EventCount< int > CurrentCount [get]
 The current number of DataWriters with which the DataReader is matched. More...
 
int CurrentCountPeak [get]
 Greatest number of DataWriters that matched this DataReader simultaneously. More...
 
InstanceHandle LastPublicationHandle [get]
 This InstanceHandle can be used to look up which remote DataWriter was the last to cause this DataReader's status to change, using Subscription.AnyDataReader.GetMatchedPublicationData(in InstanceHandle) More...
 

Detailed Description

Indicates that the Subscription.DataReader<T> discovered a matching Publication.DataWriter<T>.

The full documentation is available in the C API: DDS_SubscriptionMatchedStatus

Member Function Documentation

◆ GetHashCode()

override int Rti.Dds.Core.Status.SubscriptionMatchedStatus.GetHashCode ( )
inline

Gets the hash code.

◆ Equals() [1/2]

override bool Rti.Dds.Core.Status.SubscriptionMatchedStatus.Equals ( object  other)

Compares for equality.

◆ Equals() [2/2]

bool Rti.Dds.Core.Status.SubscriptionMatchedStatus.Equals ( SubscriptionMatchedStatus  other)
inline

Compares for equality.

◆ ToString()

override string Rti.Dds.Core.Status.SubscriptionMatchedStatus.ToString ( )

Returns a readable summary of the status

Property Documentation

◆ TotalCount

EventCount<int> Rti.Dds.Core.Status.SubscriptionMatchedStatus.TotalCount
get

The total cumulative number of times that this DataReader discovered a "match" with a DataWriter.

The full documentation is available in the C API: DDS_SubscriptionMatchedStatus_total_count

◆ CurrentCount

EventCount<int> Rti.Dds.Core.Status.SubscriptionMatchedStatus.CurrentCount
get

The current number of DataWriters with which the DataReader is matched.

The full documentation is available in the C API: DDS_SubscriptionMatchedStatus_current_count

◆ CurrentCountPeak

int Rti.Dds.Core.Status.SubscriptionMatchedStatus.CurrentCountPeak
get

Greatest number of DataWriters that matched this DataReader simultaneously.

The full documentation is available in the C API: DDS_SubscriptionMatchedStatus_current_count_peak

◆ LastPublicationHandle

InstanceHandle Rti.Dds.Core.Status.SubscriptionMatchedStatus.LastPublicationHandle
get

This InstanceHandle can be used to look up which remote DataWriter was the last to cause this DataReader's status to change, using Subscription.AnyDataReader.GetMatchedPublicationData(in InstanceHandle)

The full documentation is available in the C API: DDS_SubscriptionMatchedStatus_last_publication_handle