DataReaderCacheStatus Class Reference

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

Equals() [1/2]

bool Equals

(

DataReaderCacheStatus

other

)

Compares for equality

Equals() [2/2]

override bool Equals

(

object

other

)

Compares for equality

GetHashCode()

override int GetHashCode

(

)

Gets the hash code

ToString()

override string ToString

(

)

Returns a readable summary of the status

Property Documentation

AliveInstanceCount

long 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 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

CompressedSampleCount

long 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

ContentFilterDroppedSampleCount

long 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

DetachedInstanceCount

long 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 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

DisposedInstanceCount

long 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 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

ExpiredDroppedSampleCount

long 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

NoWritersInstanceCount

long 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 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

OldSourceTimestampDroppedSampleCount

long 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

OwnershipDroppedSampleCount

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.

The full documentation is available in the C API: DDS_DataReaderCacheStatus::ownership_dropped_sample_count

ReplacedDroppedSampleCount

long 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

SampleCount

long SampleCount

get

The number of samples in the reader's queue.

The full documentation is available in the C API: DDS_DataReaderCacheStatus::sample_count

SampleCountPeak

long 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

TimeBasedFilterDroppedSampleCount

long 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

ToleranceSourceTimestampDroppedSampleCount

long 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

TotalSamplesDroppedByInstanceReplacement

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.

The full documentation is available in the C API: DDS_DataReaderCacheStatus::total_samples_dropped_by_instance_replacement

VirtualDuplicateDroppedSampleCount

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.

The full documentation is available in the C API: DDS_DataReaderCacheStatus::virtual_duplicate_dropped_sample_count

WriterRemovedBatchSampleDroppedSampleCount

long 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