ReliableWriterCacheChangedStatus Class Reference

A summary of the state of a data writer's cache of unacknowledged samples written. More...

Inherits IEquatable< ReliableWriterCacheChangedStatus >.

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

Properties
EventCount< int >	EmptyReliableWriterCache [get]
	The number of times the reliable writer's cache of unacknowledged samples has become empty. More...
EventCount< int >	FullReliableWriterCache [get]
	The number of times the reliable writer's cache, or send window, of unacknowledged samples has become full. More...
EventCount< int >	LowWatermarkReliableWriterCache [get]
	The number of times the reliable writer's cache of unacknowledged samples has fallen to the low watermark. More...
EventCount< int >	HighWatermarkReliableWriterCache [get]
	The number of times the reliable writer's cache of unacknowledged samples has risen to the high watermark. More...
int	UnacknowledgedSampleCount [get]
	The current number of unacknowledged samples in the writer's cache. More...
int	UnacknowledgedSampleCountPeak [get]
	The highest value that unacknowledged_sample_count has reached until now. More...
long	ReplacedUnacknowledgedSampleCount [get]
	The number of unacknowledged samples that have been replaced in the writer's cache. More...

Detailed Description

A summary of the state of a data writer's cache of unacknowledged samples written.

The full documentation is available in the C API: DDS_ReliableWriterCacheChangedStatus

Member Function Documentation

Equals() [1/2]

override bool Equals

(

object

other

)

Compares for equality

Equals() [2/2]

bool Equals

(

ReliableWriterCacheChangedStatus

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

EmptyReliableWriterCache

EventCount<int> EmptyReliableWriterCache

get

The number of times the reliable writer's cache of unacknowledged samples has become empty.

The full documentation is available in the C API: DDS_ReliableWriterCacheChangedStatus::empty_reliable_writer_cache

FullReliableWriterCache

EventCount<int> FullReliableWriterCache

get

The number of times the reliable writer's cache, or send window, of unacknowledged samples has become full.

The full documentation is available in the C API: DDS_ReliableWriterCacheChangedStatus::full_reliable_writer_cache

HighWatermarkReliableWriterCache

EventCount<int> HighWatermarkReliableWriterCache

get

The number of times the reliable writer's cache of unacknowledged samples has risen to the high watermark.

The full documentation is available in the C API: DDS_ReliableWriterCacheChangedStatus::high_watermark_reliable_writer_cache

LowWatermarkReliableWriterCache

EventCount<int> LowWatermarkReliableWriterCache

get

The number of times the reliable writer's cache of unacknowledged samples has fallen to the low watermark.

The full documentation is available in the C API: DDS_ReliableWriterCacheChangedStatus::low_watermark_reliable_writer_cache

ReplacedUnacknowledgedSampleCount

long ReplacedUnacknowledgedSampleCount

get

The number of unacknowledged samples that have been replaced in the writer's cache.

The full documentation is available in the C API: DDS_ReliableWriterCacheChangedStatus::replaced_unacknowledged_sample_count

UnacknowledgedSampleCount

int UnacknowledgedSampleCount

get

The current number of unacknowledged samples in the writer's cache.

The full documentation is available in the C API: DDS_ReliableWriterCacheChangedStatus::unacknowledged_sample_count

UnacknowledgedSampleCountPeak

int UnacknowledgedSampleCountPeak

get

The highest value that unacknowledged_sample_count has reached until now.

The full documentation is available in the C API: DDS_ReliableWriterCacheChangedStatus::unacknowledged_sample_count_peak