DataWriterCacheStatus Class Reference

The status of the DataWriter's cache. Provides information on cache related metrics such as the number of samples and instances in the DataWriter queue. More...

Inherits IEquatable< DataWriterCacheStatus >.

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

Properties
long	SampleCountPeak [get]
	The highest value of SampleCount over the lifetime of the DataWriter. More...
long	SampleCount [get]
	The number of samples in the DataWriter's queue. This statistic includes meta-samples that represent the unregistration or disposal of an instance. More...
long	AliveInstanceCount [get]
	The number of instances currently in the DataWriter's queue that have an instance_state equal to Omg.Dds.Subscription.InstanceState.Alive. More...
long	AliveInstanceCountPeak [get]
	The highest value of AliveInstanceCount over the lifetime of the DataWriter. More...
long	DisposedInstanceCount [get]
	The number of instances currently in the DataWriter's queue that have an instance_state equal to Omg.Dds.Subscription.InstanceState.NotAliveDisposed (due to, for example, being disposed via the Publication.AnyDataWriter.DisposeInstance(in InstanceHandle) operation). More...
long	DisposedInstanceCountPeak [get]
	The highest value of DisposedInstanceCount over the lifetime of the DataWriter. More...
long	UnregisteredInstanceCount [get]
	The number of instances currently in the DataWriter's queue that the DataWriter has unregistered from via the Publication.AnyDataWriter.UnregisterInstance(in InstanceHandle) operation. More...
long	UnregisteredInstanceCountPeak [get]
	The highest value of UnregisteredInstanceCount over the lifetime of the DataWriter. More...

Detailed Description

The status of the DataWriter's cache. Provides information on cache related metrics such as the number of samples and instances in the DataWriter queue.

The full documentation is available in the C API: DDS_DataWriterCacheStatus

Member Function Documentation

Equals() [1/2]

bool Equals

(

DataWriterCacheStatus

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 currently in the DataWriter's queue that have an instance_state equal to Omg.Dds.Subscription.InstanceState.Alive.

The full documentation is available in the C API: DDS_DataWriterCacheStatus::alive_instance_count

AliveInstanceCountPeak

long AliveInstanceCountPeak

get

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

The full documentation is available in the C API: DDS_DataWriterCacheStatus::alive_instance_count_peak

DisposedInstanceCount

long DisposedInstanceCount

get

The number of instances currently in the DataWriter's queue that have an instance_state equal to Omg.Dds.Subscription.InstanceState.NotAliveDisposed (due to, for example, being disposed via the Publication.AnyDataWriter.DisposeInstance(in InstanceHandle) operation).

The full documentation is available in the C API: DDS_DataWriterCacheStatus::disposed_instance_count

DisposedInstanceCountPeak

long DisposedInstanceCountPeak

get

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

The full documentation is available in the C API: DDS_DataWriterCacheStatus::disposed_instance_count_peak

SampleCount

long SampleCount

get

The number of samples in the DataWriter's queue. This statistic includes meta-samples that represent the unregistration or disposal of an instance.

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

SampleCountPeak

long SampleCountPeak

get

The highest value of SampleCount over the lifetime of the DataWriter.

The full documentation is available in the C API: DDS_DataWriterCacheStatus::sample_count_peak

UnregisteredInstanceCount

long UnregisteredInstanceCount

get

The number of instances currently in the DataWriter's queue that the DataWriter has unregistered from via the Publication.AnyDataWriter.UnregisterInstance(in InstanceHandle) operation.

The full documentation is available in the C API: DDS_DataWriterCacheStatus::unregistered_instance_count

UnregisteredInstanceCountPeak

long UnregisteredInstanceCountPeak

get

The highest value of UnregisteredInstanceCount over the lifetime of the DataWriter.

The full documentation is available in the C API: DDS_DataWriterCacheStatus::unregistered_instance_count_peak