DataReaderProtocolStatus Class Reference

<<extension>> 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 Status.

Public Attributes
long	received_sample_count
	The number of samples received by a DataReader.
long	received_sample_count_change
	The incremental change in the number of samples received from a DataReader since the last time the status was read.
long	received_sample_bytes
	The number of bytes received by a DataReader.
long	received_sample_bytes_change
	The incremental change in the number of bytes received from a DataReader since the last time the status was read.
long	duplicate_sample_count
	The number of samples from a remote DataWriter received, not for the first time, by a local DataReader.
long	duplicate_sample_count_change
	The incremental change in the number of samples from a remote DataWriter received, not for the first time, by a local DataReader since the last time the status was read.
long	duplicate_sample_bytes
	The number of bytes of samples from a remote DataWriter received, not for the first time, by a local DataReader.
long	duplicate_sample_bytes_change
	The incremental change in the number of bytes of samples from a remote DataWriter received, not for the first time, by a local DataReader since the last time the status was read.
long	filtered_sample_count
	The number of user samples filtered by the local DataReader due to Content-Filtered Topics or Time-Based Filter.
long	filtered_sample_count_change
	The incremental change in the number of user samples filtered by the local DataReader due to Content-Filtered Topics or Time-Based Filter since the last time the status was read.
long	filtered_sample_bytes
	The number of bytes of user samples filtered by the local DataReader due to Content-Filtered Topics or Time-Based Filter.
long	filtered_sample_bytes_change
	The incremental change in the number of bytes of user samples filtered by the local DataReader due to Content-Filtered Topics or Time-Based Filter since the last time the status was read.
long	received_heartbeat_count
	The number of Heartbeats from a remote DataWriter received by a local DataReader.
long	received_heartbeat_count_change
	The incremental change in the number of Heartbeats from a remote DataWriter received by a local DataReader since the last time the status was read.
long	received_heartbeat_bytes
	The number of bytes of Heartbeats from a remote DataWriter received by a local DataReader.
long	received_heartbeat_bytes_change
	The incremental change in the number of bytes of Heartbeats from a remote DataWriter received by a local DataReader since the last time the status was read.
long	sent_ack_count
	The number of ACKs sent from a local DataReader to a matching remote DataWriter.
long	sent_ack_count_change
	The incremental change in the number of ACKs sent from a local DataReader to a matching remote DataWriter since the last time the status was read.
long	sent_ack_bytes
	The number of bytes of ACKs sent from a local DataReader to a matching remote DataWriter.
long	sent_ack_bytes_change
	The incremental change in the number of bytes of ACKs sent from a local DataReader to a matching remote DataWriter since the last time the status was read.
long	sent_nack_count
	The number of NACKs sent from a local DataReader to a matching remote DataWriter.
long	sent_nack_count_change
	The incremental change in the number of NACKs sent from a local DataReader to a matching remote DataWriter since the last time the status was read.
long	sent_nack_bytes
	The number of bytes of NACKs sent from a local DataReader to a matching remote DataWriter.
long	sent_nack_bytes_change
	The incremental change in the number of bytes of NACKs sent from a local DataReader to a matching remote DataWriter since the last time the status was read.
long	received_gap_count
	The number of GAPs received from remote DataWriter to this DataReader.
long	received_gap_count_change
	The incremental change in the number of GAPs received from remote DataWriter to this DataReader since the last time the status was read.
long	received_gap_bytes
	The number of bytes of GAPs received from remote DataWriter to this DataReader.
long	received_gap_bytes_change
	The incremental change in the number of bytes of GAPs received from remote DataWriter to this DataReader since the last time the status was read.
long	rejected_sample_count
	The number of times a sample is rejected due to exceptions in the receive path.
long	rejected_sample_count_change
	The incremental change in the number of times a sample is rejected due to exceptions in the receive path since the last time the status was read.
SequenceNumber_t	first_available_sample_sequence_number
	Sequence number of the first available sample in a matched DataWriters reliability queue.
SequenceNumber_t	last_available_sample_sequence_number
	Sequence number of the last available sample in a matched Datawriter's reliability queue.
SequenceNumber_t	last_committed_sample_sequence_number
	Sequence number of the newest sample received from the matched DataWriter committed to the DataReader's queue.
int	uncommitted_sample_count
	Number of received samples that are not yet available to be read or taken, due to being received out of order.

Additional Inherited Members
Public Member Functions inherited from Struct
abstract boolean	equals (Object obj)
abstract int	hashCode ()
String	toString ()
Protected Member Functions inherited from Struct
	Struct ()
abstract void	pull_from_nativeI (long native_status)
abstract void	push_to_nativeI (long native_status)

Detailed Description

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

Entity:

com.rti.dds.subscription.DataReader

Member Data Documentation

long received_sample_count

The number of samples received by a DataReader.

Depending on how the com.rti.dds.subscription.DataReaderProtocolStatus was obtained this may count samples coming from a specific DataWriter or from all the DataWriters that are matched with the DataReader.

If the com.rti.dds.subscription.DataReaderProtocolStatus is obtained using the com.rti.dds.subscription.DataReader.get_datareader_protocol_status operation then it will count samples from any DataWriter. If the DataReaderProtocolStatus is obtained using the com.rti.dds.subscription.DataReader.get_matched_publication_datareader_protocol_status then it will count the samples for the DataWriter specified as a parameter to the function.

Duplicate samples arriving from the DataWriter(s) (e.g. via multiple network paths) are detected prior to increasing this counter. The duplicate samples are counted by com.rti.dds.subscription.DataReaderProtocolStatus.duplicate_sample_count.

If the DataReader has specified a ContentFilter the received samples that do not pass the filter are part of this counter. The filtered samples are counted by com.rti.dds.subscription.DataReaderProtocolStatus.filtered_sample_count.

Samples rejected because they do not fit on the DataReader Queue are also part of this counter.

Note the received_sample_count counts samples received from all DataWriters and it does not necessarily match the number of samples accepted into the DataReader Queue. This is because:

• Samples can also be inserted into the DataReader Queue by lifecycle events that are locally detected like an instance becoming not alive as a result of DataWriters leaving the network.
• Samples can be filtered out due to ContentFilter or TimeFilter
• Samples can be rejected because there is no space in DataReader Queue

long received_sample_count_change

The incremental change in the number of samples received from a DataReader since the last time the status was read.

See Also

com.rti.dds.subscription.DataReaderProtocolStatus.received_sample_count

long received_sample_bytes

The number of bytes received by a DataReader.

See Also

com.rti.dds.subscription.DataReaderProtocolStatus.received_sample_count

long received_sample_bytes_change

The incremental change in the number of bytes received from a DataReader since the last time the status was read.

See Also

com.rti.dds.subscription.DataReaderProtocolStatus.received_sample_count_change

long duplicate_sample_count

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

Such samples can be redundant, out-of-order, etc. and are not stored in the reader's queue.

long duplicate_sample_count_change

The incremental change in the number of samples from a remote DataWriter received, not for the first time, by a local DataReader since the last time the status was read.

Such samples can be redundant, out-of-order, etc. and are not stored in the reader's queue.

long duplicate_sample_bytes

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

Such samples can be redundant, out-of-order, etc. and are not stored in the reader's queue.

long duplicate_sample_bytes_change

The incremental change in the number of bytes of samples from a remote DataWriter received, not for the first time, by a local DataReader since the last time the status was read.

Such samples can be redundant, out-of-order, etc. and are not stored in the reader's queue.

long filtered_sample_count

The number of user samples filtered by the local DataReader due to Content-Filtered Topics or Time-Based Filter.

long filtered_sample_count_change

The incremental change in the number of user samples filtered by the local DataReader due to Content-Filtered Topics or Time-Based Filter since the last time the status was read.

long filtered_sample_bytes

The number of bytes of user samples filtered by the local DataReader due to Content-Filtered Topics or Time-Based Filter.

long filtered_sample_bytes_change

The incremental change in the number of bytes of user samples filtered by the local DataReader due to Content-Filtered Topics or Time-Based Filter since the last time the status was read.

long received_heartbeat_count

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

long received_heartbeat_count_change

The incremental change in the number of Heartbeats from a remote DataWriter received by a local DataReader since the last time the status was read.

long received_heartbeat_bytes

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

long received_heartbeat_bytes_change

The incremental change in the number of bytes of Heartbeats from a remote DataWriter received by a local DataReader since the last time the status was read.

long sent_ack_count

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

long sent_ack_count_change

The incremental change in the number of ACKs sent from a local DataReader to a matching remote DataWriter since the last time the status was read.

long sent_ack_bytes

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

long sent_ack_bytes_change

The incremental change in the number of bytes of ACKs sent from a local DataReader to a matching remote DataWriter since the last time the status was read.

long sent_nack_count

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

long sent_nack_count_change

The incremental change in the number of NACKs sent from a local DataReader to a matching remote DataWriter since the last time the status was read.

long sent_nack_bytes

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

long sent_nack_bytes_change

The incremental change in the number of bytes of NACKs sent from a local DataReader to a matching remote DataWriter since the last time the status was read.

long received_gap_count

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

long received_gap_count_change

The incremental change in the number of GAPs received from remote DataWriter to this DataReader since the last time the status was read.

long received_gap_bytes

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

long received_gap_bytes_change

The incremental change in the number of bytes of GAPs received from remote DataWriter to this DataReader since the last time the status was read.

long rejected_sample_count

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

long rejected_sample_count_change

The incremental change in the number of times a sample is rejected due to exceptions in the receive path since the last time the status was read.

SequenceNumber_t first_available_sample_sequence_number

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

Applicable only for reliable DataReaders, and when retrieving matched DataWriter statuses.

Updated upon receiving Heartbeat submessages from a matched reliable DataWriter.

SequenceNumber_t last_available_sample_sequence_number

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

Applicable only for reliable DataReaders, and when retrieving matched DataWriter statuses.

Updated upon receiving Heartbeat submessages from a matched reliable DataWriter.

SequenceNumber_t last_committed_sample_sequence_number

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

Applicable only when retrieving matched DataWriter statuses.

For best-effort DataReaders, this is the sequence number of the latest sample received.

For reliable DataReaders, this is the sequence number of the latest sample that is available to be read or taken from the DataReader's queue.

int uncommitted_sample_count

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

Applicable only when retrieving matched DataWriter statuses.