DataReaderProtocolStatus Class Reference

The status of a reader's internal protocol related metrics, like the number of samples received, filtered, rejected; and status of wire protocol traffic. More...

Inherits IEquatable< DataReaderProtocolStatus >.

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

Properties
EventCount< long >	ReceivedSampleCount [get]
	The number of samples received by a DataReader. More...
EventCount< long >	ReceivedSampleBytes [get]
	The number of bytes received by a DataReader. More...
EventCount< long >	DuplicateSampleCount [get]
	The number of samples from a remote DataWriter received, not for the first time, by a local DataReader. More...
EventCount< long >	DuplicateSampleBytes [get]
	The number of bytes of samples from a remote DataWriter received, not for the first time, by a local DataReader. More...
EventCount< long >	ReceivedHeartbeatCount [get]
	The number of Heartbeats from a remote DataWriter received by a local DataReader. More...
EventCount< long >	ReceivedHeartbeatBytes [get]
	The number of bytes of Heartbeats from a remote DataWriter received by a local DataReader. More...
EventCount< long >	SentAckCount [get]
	The number of ACKs sent from a local DataReader to a matching remote DataWriter. More...
EventCount< long >	SentAckBytes [get]
	The number of bytes of ACKs sent from a local DataReader to a matching remote DataWriter. More...
EventCount< long >	SentNackCount [get]
	The number of NACKs sent from a local DataReader to a matching remote DataWriter. More...
EventCount< long >	SentNackBytes [get]
	The number of bytes of NACKs sent from a local DataReader to a matching remote DataWriter. More...
EventCount< long >	ReceivedGapCount [get]
	The number of GAPs received from remote DataWriter to this DataReader. More...
EventCount< long >	ReceivedGapBytes [get]
	The number of bytes of GAPs received from remote DataWriter to this DataReader. More...
EventCount< long >	RejectedSampleCount [get]
	The number of times a sample is rejected due to exceptions in the receive path. More...
long	FirstAvailableSampleSequenceNumber [get]
	Sequence number of the first available sample in a matched DataWriters reliability queue. More...
long	LastAvailableSampleSequenceNumber [get]
	Sequence number of the last available sample in a matched Datawriter's reliability queue. More...
long	LastCommittedSampleSequenceNumber [get]
	Sequence number of the newest sample received from the matched DataWriter committed to the DataReader's queue. More...
int	UncommittedSampleCount [get]
	Number of received samples that are not yet available to be read or taken, due to being received out of order. More...
long	OutOfRangeRejectedSampleCount [get]
	The number of samples dropped by the DataReader due to received window is full and the sample is out-of-order. More...
long	ReceivedFragmentCount [get]
	The number of DATA_FRAG messages that have been received by this DataReader. More...
long	DroppedFragmentCount [get]
	The number of DATA_FRAG messages that have been dropped by a DataReader. More...
long	ReassembledSampleCount [get]
	The number of fragmented samples that have been reassembled by a DataReader. More...
long	SentNackFragmentCount [get]
	The number of NACK fragments that have been sent from a DataReader to a DataWriter. More...
long	SentNackFragmentBytes [get]
	The number of NACK fragment bytes that have been sent from a DataReader to a DataWriter. More...

Detailed Description

The status of a reader's internal protocol related metrics, like the number of samples received, filtered, rejected; and status of wire protocol traffic.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus

Member Function Documentation

Equals() [1/2]

bool Equals

(

DataReaderProtocolStatus

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

DroppedFragmentCount

long DroppedFragmentCount

get

The number of DATA_FRAG messages that have been dropped by a DataReader.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::dropped_fragment_count

DuplicateSampleBytes

EventCount<long> DuplicateSampleBytes

get

The number of bytes of samples from a remote DataWriter received, not for the first time, by a local DataReader.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::duplicate_sample_bytes

DuplicateSampleCount

EventCount<long> DuplicateSampleCount

get

The number of samples from a remote DataWriter received, not for the first time, by a local DataReader.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::duplicate_sample_count

FirstAvailableSampleSequenceNumber

long FirstAvailableSampleSequenceNumber

get

Sequence number of the first available sample in a matched DataWriters reliability queue.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::first_available_sample_sequence_number

LastAvailableSampleSequenceNumber

long LastAvailableSampleSequenceNumber

get

Sequence number of the last available sample in a matched Datawriter's reliability queue.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::last_available_sample_sequence_number

LastCommittedSampleSequenceNumber

long LastCommittedSampleSequenceNumber

get

Sequence number of the newest sample received from the matched DataWriter committed to the DataReader's queue.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::last_committed_sample_sequence_number

OutOfRangeRejectedSampleCount

long OutOfRangeRejectedSampleCount

get

The number of samples dropped by the DataReader due to received window is full and the sample is out-of-order.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::out_of_range_rejected_sample_count

ReassembledSampleCount

long ReassembledSampleCount

get

The number of fragmented samples that have been reassembled by a DataReader.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::reassembled_sample_count

ReceivedFragmentCount

long ReceivedFragmentCount

get

The number of DATA_FRAG messages that have been received by this DataReader.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::received_fragment_count

ReceivedGapBytes

EventCount<long> ReceivedGapBytes

get

The number of bytes of GAPs received from remote DataWriter to this DataReader.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::received_gap_bytes

ReceivedGapCount

EventCount<long> ReceivedGapCount

get

The number of GAPs received from remote DataWriter to this DataReader.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::received_gap_count

ReceivedHeartbeatBytes

EventCount<long> ReceivedHeartbeatBytes

get

The number of bytes of Heartbeats from a remote DataWriter received by a local DataReader.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::received_heartbeat_bytes

ReceivedHeartbeatCount

EventCount<long> ReceivedHeartbeatCount

get

The number of Heartbeats from a remote DataWriter received by a local DataReader.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::received_heartbeat_count

ReceivedSampleBytes

EventCount<long> ReceivedSampleBytes

get

The number of bytes received by a DataReader.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::received_sample_bytes

ReceivedSampleCount

EventCount<long> ReceivedSampleCount

get

The number of samples received by a DataReader.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::received_sample_count

RejectedSampleCount

EventCount<long> RejectedSampleCount

get

The number of times a sample is rejected due to exceptions in the receive path.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::rejected_sample_count

SentAckBytes

EventCount<long> SentAckBytes

get

The number of bytes of ACKs sent from a local DataReader to a matching remote DataWriter.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::sent_ack_bytes

SentAckCount

EventCount<long> SentAckCount

get

The number of ACKs sent from a local DataReader to a matching remote DataWriter.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::sent_ack_count

SentNackBytes

EventCount<long> SentNackBytes

get

The number of bytes of NACKs sent from a local DataReader to a matching remote DataWriter.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::sent_nack_bytes

SentNackCount

EventCount<long> SentNackCount

get

The number of NACKs sent from a local DataReader to a matching remote DataWriter.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::sent_nack_count

SentNackFragmentBytes

long SentNackFragmentBytes

get

The number of NACK fragment bytes that have been sent from a DataReader to a DataWriter.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::sent_nack_fragment_bytes

SentNackFragmentCount

long SentNackFragmentCount

get

The number of NACK fragments that have been sent from a DataReader to a DataWriter.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::sent_nack_fragment_count

UncommittedSampleCount

int UncommittedSampleCount

get

Number of received samples that are not yet available to be read or taken, due to being received out of order.

The full documentation is available in the C API: DDS_DataReaderProtocolStatus::uncommitted_sample_count