DataWriterProtocolStatus Class Reference
[Data Writers]

<<eXtension>> The status of a writer's internal protocol related metrics, like the number of samples pushed, pulled, filtered; and status of wire protocol traffic. More...

Inherits Status.

List of all members.

Public Attributes
long	pushed_sample_count
	The number of user samples pushed on write from a local DataWriter to a matching remote DataReader.
long	pushed_sample_count_change
	The incremental change in the number of user samples pushed on write from a local DataWriter to a matching remote DataReader since the last time the status was read.
long	pushed_sample_bytes
	The number of bytes of user samples pushed on write from a local DataWriter to a matching remote DataReader.
long	pushed_sample_bytes_change
	The incremental change in the number of bytes of user samples pushed on write from a local DataWriter to a matching remote DataReader since the last time the status was read.
long	filtered_sample_count
	The number of user samples preemptively filtered by a local DataWriter due to Content-Filtered Topics.
long	filtered_sample_count_change
	The incremental change in the number of user samples preemptively filtered by a local DataWriter due to Content-Filtered Topics since the last time the status was read.
long	filtered_sample_bytes
	The number of user samples preemptively filtered by a local DataWriter due to Content-Filtered Topics.
long	filtered_sample_bytes_change
	The incremental change in the number of user samples preemptively filtered by a local DataWriter due to Content-Filtered Topics since the last time the status was read.
long	sent_heartbeat_count
	The number of Heartbeats sent between a local DataWriter and matching remote DataReader.
long	sent_heartbeat_count_change
	The incremental change in the number of Heartbeats sent between a local DataWriter and matching remote DataReader since the last time the status was read.
long	sent_heartbeat_bytes
	The number of bytes of Heartbeats sent between a local DataWriter and matching remote DataReader.
long	sent_heartbeat_bytes_change
	The incremental change in the number of bytes of Heartbeats sent between a local DataWriter and matching remote DataReader since the last time the status was read.
long	pulled_sample_count
	The number of user samples pulled from local DataWriter by matching DataReaders.
long	pulled_sample_count_change
	The incremental change in the number of user samples pulled from local DataWriter by matching DataReaders since the last time the status was read.
long	pulled_sample_bytes
	The number of bytes of user samples pulled from local DataWriter by matching DataReaders.
long	pulled_sample_bytes_change
	The incremental change in the number of bytes of user samples pulled from local DataWriter by matching DataReaders since the last time the status was read.
long	received_ack_count
	The number of ACKs from a remote DataReader received by a local DataWriter.
long	received_ack_count_change
	The incremental change in the number of ACKs from a remote DataReader received by a local DataWriter since the last time the status was read.
long	received_ack_bytes
	The number of bytes of ACKs from a remote DataReader received by a local DataWriter.
long	received_ack_bytes_change
	The incremental change in the number of bytes of ACKs from a remote DataReader received by a local DataWriter since the last time the status was read.
long	received_nack_count
	The number of NACKs from a remote DataReader received by a local DataWriter.
long	received_nack_count_change
	The incremental change in the number of NACKs from a remote DataReader received by a local DataWriter since the last time the status was read.
long	received_nack_bytes
	The number of bytes of NACKs from a remote DataReader received by a local DataWriter.
long	received_nack_bytes_change
	The incremental change in the number of bytes of NACKs from a remote DataReader received by a local DataWriter since the last time the status was read.
long	sent_gap_count
	The number of GAPs sent from local DataWriter to matching remote DataReaders.
long	sent_gap_count_change
	The incremental change in the number of GAPs sent from local DataWriter to matching remote DataReaders since the last time the status was read.
long	sent_gap_bytes
	The number of bytes of GAPs sent from local DataWriter to matching remote DataReaders.
long	sent_gap_bytes_change
	The incremental change in the number of bytes of GAPs sent from local DataWriter to matching remote DataReaders 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 send path.
long	rejected_sample_count_change
	The incremental change in the number of times a sample is rejected due to exceptions in the send path since the last time the status was read.
int	send_window_size
	Current maximum number of outstanding samples allowed in the DataWriter's queue.
SequenceNumber_t	first_available_sample_sequence_number
	The sequence number of the first available sample currently queued in the local DataWriter.
SequenceNumber_t	last_available_sample_sequence_number
	The sequence number of the last available sample currently queued in the local DataWriter.
SequenceNumber_t	first_unacknowledged_sample_sequence_number
	The sequence number of the first unacknowledged sample currently queued in the local DataWriter.
SequenceNumber_t	first_available_sample_virtual_sequence_number
	The virtual sequence number of the first available sample currently queued in the local DataWriter.
SequenceNumber_t	last_available_sample_virtual_sequence_number
	The virtual sequence number of the last available sample currently queued in the local DataWriter.
SequenceNumber_t	first_unacknowledged_sample_virtual_sequence_number
	The virtual sequence number of the first unacknowledged sample currently queued in the local DataWriter.
InstanceHandle_t	first_unacknowledged_sample_subscription_handle
	The handle of a remote DataReader that has not acknowledged the first unacknowledged sample of the local DataWriter.
SequenceNumber_t	first_unelapsed_keep_duration_sample_sequence_number
	The sequence number of the first sample whose keep duration has not yet elapsed.

---

Detailed Description

<<eXtension>> The status of a writer's internal protocol related metrics, like the number of samples pushed, pulled, filtered; and status of wire protocol traffic.

Entity:

com.rti.dds.publication.DataWriter

---

Member Data Documentation

long pushed_sample_count

The number of user samples pushed on write from a local DataWriter to a matching remote DataReader.

Counts protocol (RTPS) messages pushed by a DataWriter when writing, unregistering, and disposing. The count is the number of sends done internally, and it may be greater than the number of user writes.

For large data, counts whole samples, not fragments.

long pushed_sample_count_change

The incremental change in the number of user samples pushed on write from a local DataWriter to a matching remote DataReader since the last time the status was read.

Counts protocol (RTPS) messages pushed by a DataWriter when writing, unregistering, and disposing.

For large data, counts whole samples, not fragments.

long pushed_sample_bytes

The number of bytes of user samples pushed on write from a local DataWriter to a matching remote DataReader.

Counts bytes of protocol (RTPS) messages pushed by a DataWriter when writing, unregistering, and disposing. The count of bytes corresponds to the number of sends done internally, and it may be greater than the number of user writes.

For large data, counts bytes of whole samples, not fragments.

long pushed_sample_bytes_change

The incremental change in the number of bytes of user samples pushed on write from a local DataWriter to a matching remote DataReader since the last time the status was read.

Counts bytes of protocol (RTPS) messages pushed by a DataWriter when writing, unregistering, and disposing.

For large data, counts bytes of whole samples, not fragments.

long filtered_sample_count

The number of user samples preemptively filtered by a local DataWriter due to Content-Filtered Topics.

long filtered_sample_count_change

The incremental change in the number of user samples preemptively filtered by a local DataWriter due to Content-Filtered Topics since the last time the status was read.

long filtered_sample_bytes

The number of user samples preemptively filtered by a local DataWriter due to Content-Filtered Topics.

long filtered_sample_bytes_change

The incremental change in the number of user samples preemptively filtered by a local DataWriter due to Content-Filtered Topics since the last time the status was read.

long sent_heartbeat_count

The number of Heartbeats sent between a local DataWriter and matching remote DataReader.

Because periodic and piggyback heartbeats are sent to remote readers and their locators differently in different situations, when a reader has more than one locator, this count may be larger than expected, to reflect the sending of Heartbeats to the multiple locators.

long sent_heartbeat_count_change

The incremental change in the number of Heartbeats sent between a local DataWriter and matching remote DataReader since the last time the status was read.

long sent_heartbeat_bytes

The number of bytes of Heartbeats sent between a local DataWriter and matching remote DataReader.

Because periodic and piggyback heartbeats are sent to remote readers and their locators differently in different situations, when a reader has more than one locator, this count may be larger than expected, to reflect the sending of Heartbeats to the multiple locators.

long sent_heartbeat_bytes_change

The incremental change in the number of bytes of Heartbeats sent between a local DataWriter and matching remote DataReader since the last time the status was read.

long pulled_sample_count

The number of user samples pulled from local DataWriter by matching DataReaders.

Pulled samples are samples sent for repairs, for late joiners, and all samples sent by the local DataWriter when com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.push_on_write is false.

For large data, counts whole samples, not fragments.

long pulled_sample_count_change

The incremental change in the number of user samples pulled from local DataWriter by matching DataReaders since the last time the status was read.

Pulled samples are samples sent for repairs, for late joiners, and all samples sent by the local DataWriter when com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.push_on_write is false.

For large data, counts whole samples, not fragments.

long pulled_sample_bytes

The number of bytes of user samples pulled from local DataWriter by matching DataReaders.

Pulled samples are samples sent for repairs, for late joiners, and all samples sent by the local DataWriter when com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.push_on_write is false.

For large data, counts bytes of whole samples, not fragments.

long pulled_sample_bytes_change

The incremental change in the number of bytes of user samples pulled from local DataWriter by matching DataReaders since the last time the status was read.

Pulled samples are samples sent for repairs, for late joiners, and all samples sent by the local DataWriter when com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.push_on_write is false.

For large data, counts bytes of whole samples, not fragments.

long received_ack_count

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

long received_ack_count_change

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

long received_ack_bytes

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

long received_ack_bytes_change

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

long received_nack_count

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

long received_nack_count_change

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

long received_nack_bytes

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

long received_nack_bytes_change

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

long sent_gap_count

The number of GAPs sent from local DataWriter to matching remote DataReaders.

long sent_gap_count_change

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

long sent_gap_bytes

The number of bytes of GAPs sent from local DataWriter to matching remote DataReaders.

long sent_gap_bytes_change

The incremental change in the number of bytes of GAPs sent from local DataWriter to matching remote DataReaders 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 send path.

long rejected_sample_count_change

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

int send_window_size

Current maximum number of outstanding samples allowed in the DataWriter's queue.

Spans the range from com.rti.dds.infrastructure.RtpsReliableWriterProtocol_t.min_send_window_size to com.rti.dds.infrastructure.RtpsReliableWriterProtocol_t.max_send_window_size.

SequenceNumber_t first_available_sample_sequence_number

The sequence number of the first available sample currently queued in the local DataWriter.

Applies only for local DataWriter status.

SequenceNumber_t last_available_sample_sequence_number

The sequence number of the last available sample currently queued in the local DataWriter.

Applies only for local DataWriter status.

SequenceNumber_t first_unacknowledged_sample_sequence_number

The sequence number of the first unacknowledged sample currently queued in the local DataWriter.

Applies only for local DataWriter status.

SequenceNumber_t first_available_sample_virtual_sequence_number

The virtual sequence number of the first available sample currently queued in the local DataWriter.

Applies only for local DataWriter status.

SequenceNumber_t last_available_sample_virtual_sequence_number

The virtual sequence number of the last available sample currently queued in the local DataWriter.

Applies only for local DataWriter status.

SequenceNumber_t first_unacknowledged_sample_virtual_sequence_number

The virtual sequence number of the first unacknowledged sample currently queued in the local DataWriter.

Applies only for local DataWriter status.

InstanceHandle_t first_unacknowledged_sample_subscription_handle

The handle of a remote DataReader that has not acknowledged the first unacknowledged sample of the local DataWriter.

Applies only for local DataWriter status.

SequenceNumber_t first_unelapsed_keep_duration_sample_sequence_number

The sequence number of the first sample whose keep duration has not yet elapsed.

Applicable only when com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.disable_positive_acks is set.

Sequence number of the first sample kept in the DataWriter's queue whose keep_duration (applied when com.rti.dds.infrastructure.DataWriterProtocolQosPolicy.disable_positive_acks is set) has not yet elapsed.

Applies only for local DataWriter status.