The status of the reader's cache. More...

Inherits IEquatable< DataReaderCacheStatus >.

Public Member Functions
override int	GetHashCode ()
	Gets the hash code More...

override bool	Equals (object other)
	Compares for equality More...

bool	Equals (DataReaderCacheStatus other)
	Compares for equality More...

override string	ToString ()
	Returns a readable summary of the status More...

Properties
long	SampleCountPeak `[get]`
	The highest number of samples in the reader's queue over the lifetime of the reader. More...

long	SampleCount `[get]`
	The number of samples in the reader's queue. More...

long	OldSourceTimestampDroppedSampleCount `[get]`
	The number of samples dropped as a result of receiving a sample older than the last one, using Policy.DestinationOrderKind.BySourceTimestamp. More...

long	ToleranceSourceTimestampDroppedSampleCount `[get]`
	The number of samples dropped as a result of receiving a sample in the future, using Policy.DestinationOrderKind.BySourceTimestamp. More...

long	OwnershipDroppedSampleCount `[get]`
	The number of samples dropped as a result of receiving a sample from a DataWriter with a lower strength, using Exclusive Ownership. More...

long	ContentFilterDroppedSampleCount `[get]`
	The number of user samples filtered by the DataReader due to Content-Filtered Topics. More...

long	TimeBasedFilterDroppedSampleCount `[get]`
	The number of user samples filtered by the DataReader due to Policy.TimeBasedFilter. More...

long	ExpiredDroppedSampleCount `[get]`
	The number of samples expired by the DataReader due to Policy.Lifespan or the autopurge sample delays. More...

long	VirtualDuplicateDroppedSampleCount `[get]`
	The number of virtual duplicate samples dropped by the DataReader. A sample is a virtual duplicate if it has the same identity (Virtual Writer GUID and Virtual Sequence Number) as a previously received sample. More...

long	ReplacedDroppedSampleCount `[get]`
	The number of samples replaced by the DataReader due to Policy.HistoryKind.KeepLast replacement. More...

long	WriterRemovedBatchSampleDroppedSampleCount `[get]`
	The number of batch samples received by the DataReader that were marked as removed by the DataWriter. More...

long	TotalSamplesDroppedByInstanceReplacement `[get]`
	The number of samples with sample state Omg.Dds.Subscription.SampleState.NotRead that were dropped when removing an instance due to instance replacement. See Policy.DataReaderResourceLimits.InstanceReplacement for more details about when instances are replaced. More...

long	AliveInstanceCount `[get]`
	The number of instances in the DataReader's queue with an instance state equal to Omg.Dds.Subscription.InstanceState.Alive. More...

long	AliveInstanceCountPeak `[get]`
	The highest value of AliveInstanceCount over the lifetime of the DataReader. More...

long	NoWritersInstanceCount `[get]`
	The number of instances in the DataReader's queue with an instance state equal to Omg.Dds.Subscription.InstanceState.NotAliveNoWriters. More...

long	NoWritersInstanceCountPeak `[get]`
	The highest value of NoWritersInstanceCount over the lifetime of the DataReader. More...

long	DisposedInstanceCount `[get]`
	The number of instances in the DataReader's queue with an instance state equal to Omg.Dds.Subscription.InstanceState.NotAliveDisposed. More...

long	DisposedInstanceCountPeak `[get]`
	The highest value of DisposedInstanceCount over the lifetime of the DataReader. More...

long	DetachedInstanceCount `[get]`
	The number of minimal instance states currently being maintained in the DataReader's queue. More...

long	DetachedInstanceCountPeak `[get]`
	The highest value of DetachedInstanceCount over the lifetime of the DataReader. More...

long	CompressedSampleCount `[get]`
	The number of received compressed samples by a DataWriter. More...

Detailed Description

The status of the reader's cache.

The full documentation is available in the C API: DDS_DataReaderCacheStatus

Member Function Documentation

◆ GetHashCode()

override int Rti.Dds.Core.Status.DataReaderCacheStatus.GetHashCode ( )

inline

Gets the hash code

◆ Equals() [1/2]

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

Compares for equality

◆ Equals() [2/2]

bool Rti.Dds.Core.Status.DataReaderCacheStatus.Equals ( DataReaderCacheStatus other )

inline

Compares for equality

◆ ToString()

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

Returns a readable summary of the status

Property Documentation

◆ SampleCountPeak

long Rti.Dds.Core.Status.DataReaderCacheStatus.SampleCountPeak

get

The highest number of samples in the reader's queue over the lifetime of the reader.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_sample_count_peak

◆ SampleCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.SampleCount

get

The number of samples in the reader's queue.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_sample_count

◆ OldSourceTimestampDroppedSampleCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.OldSourceTimestampDroppedSampleCount

get

The number of samples dropped as a result of receiving a sample older than the last one, using Policy.DestinationOrderKind.BySourceTimestamp.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_old_source_timestamp_dropped_sample_count

◆ ToleranceSourceTimestampDroppedSampleCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.ToleranceSourceTimestampDroppedSampleCount

get

The number of samples dropped as a result of receiving a sample in the future, using Policy.DestinationOrderKind.BySourceTimestamp.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_tolerance_source_timestamp_dropped_sample_count

◆ OwnershipDroppedSampleCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.OwnershipDroppedSampleCount

get

The number of samples dropped as a result of receiving a sample from a DataWriter with a lower strength, using Exclusive Ownership.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_ownership_dropped_sample_count

◆ ContentFilterDroppedSampleCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.ContentFilterDroppedSampleCount

get

The number of user samples filtered by the DataReader due to Content-Filtered Topics.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_content_filter_dropped_sample_count

◆ TimeBasedFilterDroppedSampleCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.TimeBasedFilterDroppedSampleCount

get

The number of user samples filtered by the DataReader due to Policy.TimeBasedFilter.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_time_based_filter_dropped_sample_count

◆ ExpiredDroppedSampleCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.ExpiredDroppedSampleCount

get

The number of samples expired by the DataReader due to Policy.Lifespan or the autopurge sample delays.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_expired_dropped_sample_count

◆ VirtualDuplicateDroppedSampleCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.VirtualDuplicateDroppedSampleCount

get

The number of virtual duplicate samples dropped by the DataReader. A sample is a virtual duplicate if it has the same identity (Virtual Writer GUID and Virtual Sequence Number) as a previously received sample.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_virtual_duplicate_dropped_sample_count

◆ ReplacedDroppedSampleCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.ReplacedDroppedSampleCount

get

The number of samples replaced by the DataReader due to Policy.HistoryKind.KeepLast replacement.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_replaced_dropped_sample_count

◆ WriterRemovedBatchSampleDroppedSampleCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.WriterRemovedBatchSampleDroppedSampleCount

get

The number of batch samples received by the DataReader that were marked as removed by the DataWriter.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_writer_removed_batch_sample_dropped_sample_count

◆ TotalSamplesDroppedByInstanceReplacement

long Rti.Dds.Core.Status.DataReaderCacheStatus.TotalSamplesDroppedByInstanceReplacement

get

The number of samples with sample state Omg.Dds.Subscription.SampleState.NotRead that were dropped when removing an instance due to instance replacement. See Policy.DataReaderResourceLimits.InstanceReplacement for more details about when instances are replaced.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_total_samples_dropped_by_instance_replacement

◆ AliveInstanceCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.AliveInstanceCount

get

The number of instances in the DataReader's queue with an instance state equal to Omg.Dds.Subscription.InstanceState.Alive.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_alive_instance_count

◆ AliveInstanceCountPeak

long Rti.Dds.Core.Status.DataReaderCacheStatus.AliveInstanceCountPeak

get

The highest value of AliveInstanceCount over the lifetime of the DataReader.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_alive_instance_count_peak

◆ NoWritersInstanceCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.NoWritersInstanceCount

get

The number of instances in the DataReader's queue with an instance state equal to Omg.Dds.Subscription.InstanceState.NotAliveNoWriters.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_no_writers_instance_count

◆ NoWritersInstanceCountPeak

long Rti.Dds.Core.Status.DataReaderCacheStatus.NoWritersInstanceCountPeak

get

The highest value of NoWritersInstanceCount over the lifetime of the DataReader.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_no_writers_instance_count_peak

◆ DisposedInstanceCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.DisposedInstanceCount

get

The number of instances in the DataReader's queue with an instance state equal to Omg.Dds.Subscription.InstanceState.NotAliveDisposed.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_disposed_instance_count

◆ DisposedInstanceCountPeak

long Rti.Dds.Core.Status.DataReaderCacheStatus.DisposedInstanceCountPeak

get

The highest value of DisposedInstanceCount over the lifetime of the DataReader.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_disposed_instance_count_peak

◆ DetachedInstanceCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.DetachedInstanceCount

get

The number of minimal instance states currently being maintained in the DataReader's queue.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_detached_instance_count

◆ DetachedInstanceCountPeak

long Rti.Dds.Core.Status.DataReaderCacheStatus.DetachedInstanceCountPeak

get

The highest value of DetachedInstanceCount over the lifetime of the DataReader.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_detached_instance_count_peak

◆ CompressedSampleCount

long Rti.Dds.Core.Status.DataReaderCacheStatus.CompressedSampleCount

get

The number of received compressed samples by a DataWriter.

The full documentation is available in the C API: DDS_DataReaderCacheStatus_compressed_sample_count

Public Member Functions

Properties