DDS_DataWriterProtocolStatus Struct 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...

List of all members.

Public Attributes
DDS_LongLong	pushed_sample_count
	The number of user samples pushed on write from a local DataWriter to a matching remote DataReader.
DDS_LongLong	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.
DDS_LongLong	pushed_sample_bytes
	The number of bytes of user samples pushed on write from a local DataWriter to a matching remote DataReader.
DDS_LongLong	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.
DDS_LongLong	filtered_sample_count
	The number of user samples preemptively filtered by a local DataWriter due to Content-Filtered Topics.
DDS_LongLong	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.
DDS_LongLong	filtered_sample_bytes
	The number of user samples preemptively filtered by a local DataWriter due to Content-Filtered Topics.
DDS_LongLong	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.
DDS_LongLong	sent_heartbeat_count
	The number of Heartbeats sent between a local DataWriter and matching remote DataReader.
DDS_LongLong	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.
DDS_LongLong	sent_heartbeat_bytes
	The number of bytes of Heartbeats sent between a local DataWriter and matching remote DataReader.
DDS_LongLong	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.
DDS_LongLong	pulled_sample_count
	The number of user samples pulled from local DataWriter by matching DataReaders.
DDS_LongLong	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.
DDS_LongLong	pulled_sample_bytes
	The number of bytes of user samples pulled from local DataWriter by matching DataReaders.
DDS_LongLong	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.
DDS_LongLong	received_ack_count
	The number of ACKs from a remote DataReader received by a local DataWriter.
DDS_LongLong	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.
DDS_LongLong	received_ack_bytes
	The number of bytes of ACKs from a remote DataReader received by a local DataWriter.
DDS_LongLong	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.
DDS_LongLong	received_nack_count
	The number of NACKs from a remote DataReader received by a local DataWriter.
DDS_LongLong	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.
DDS_LongLong	received_nack_bytes
	The number of bytes of NACKs from a remote DataReader received by a local DataWriter.
DDS_LongLong	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.
DDS_LongLong	sent_gap_count
	The number of GAPs sent from local DataWriter to matching remote DataReaders.
DDS_LongLong	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.
DDS_LongLong	sent_gap_bytes
	The number of bytes of GAPs sent from local DataWriter to matching remote DataReaders.
DDS_LongLong	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.
DDS_LongLong	rejected_sample_count
	The number of times a sample is rejected due to exceptions in the send path.
DDS_LongLong	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.
DDS_Long	send_window_size
	Current maximum number of outstanding samples allowed in the DataWriter's queue.
struct DDS_SequenceNumber_t	first_available_sample_sequence_number
	The sequence number of the first available sample currently queued in the local DataWriter.
struct DDS_SequenceNumber_t	last_available_sample_sequence_number
	The sequence number of the last available sample currently queued in the local DataWriter.
struct DDS_SequenceNumber_t	first_unacknowledged_sample_sequence_number
	The sequence number of the first unacknowledged sample currently queued in the local DataWriter.
struct DDS_SequenceNumber_t	first_available_sample_virtual_sequence_number
	The virtual sequence number of the first available sample currently queued in the local DataWriter.
struct DDS_SequenceNumber_t	last_available_sample_virtual_sequence_number
	The virtual sequence number of the last available sample currently queued in the local DataWriter.
struct DDS_SequenceNumber_t	first_unacknowledged_sample_virtual_sequence_number
	The virtual sequence number of the first unacknowledged sample currently queued in the local DataWriter.
DDS_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.
struct DDS_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 DDS_DataWriterProtocolQosPolicy::disable_positive_acks is set.

---

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:

DDSDataWriter

---

Member Data Documentation

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::filtered_sample_count

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

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::filtered_sample_bytes

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

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::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 DDS_DataWriterProtocolQosPolicy::push_on_write is DDS_BOOLEAN_FALSE.

For large data, counts whole samples, not fragments.

DDS_LongLong DDS_DataWriterProtocolStatus::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 DDS_DataWriterProtocolQosPolicy::push_on_write is DDS_BOOLEAN_FALSE.

For large data, counts whole samples, not fragments.

DDS_LongLong DDS_DataWriterProtocolStatus::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 DDS_DataWriterProtocolQosPolicy::push_on_write is DDS_BOOLEAN_FALSE.

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

DDS_LongLong DDS_DataWriterProtocolStatus::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 DDS_DataWriterProtocolQosPolicy::push_on_write is DDS_BOOLEAN_FALSE.

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

DDS_LongLong DDS_DataWriterProtocolStatus::received_ack_count

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

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::received_ack_bytes

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

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::received_nack_count

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

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::received_nack_bytes

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

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::sent_gap_count

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

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::sent_gap_bytes

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

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_LongLong DDS_DataWriterProtocolStatus::rejected_sample_count

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

DDS_LongLong DDS_DataWriterProtocolStatus::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.

DDS_Long DDS_DataWriterProtocolStatus::send_window_size

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

Spans the range from DDS_RtpsReliableWriterProtocol_t::min_send_window_size to DDS_RtpsReliableWriterProtocol_t::max_send_window_size.

struct DDS_SequenceNumber_t DDS_DataWriterProtocolStatus::first_available_sample_sequence_number [read]

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

Applies only for local DataWriter status.

struct DDS_SequenceNumber_t DDS_DataWriterProtocolStatus::last_available_sample_sequence_number [read]

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

Applies only for local DataWriter status.

struct DDS_SequenceNumber_t DDS_DataWriterProtocolStatus::first_unacknowledged_sample_sequence_number [read]

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

Applies only for local DataWriter status.

struct DDS_SequenceNumber_t DDS_DataWriterProtocolStatus::first_available_sample_virtual_sequence_number [read]

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

Applies only for local DataWriter status.

struct DDS_SequenceNumber_t DDS_DataWriterProtocolStatus::last_available_sample_virtual_sequence_number [read]

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

Applies only for local DataWriter status.

struct DDS_SequenceNumber_t DDS_DataWriterProtocolStatus::first_unacknowledged_sample_virtual_sequence_number [read]

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

Applies only for local DataWriter status.

DDS_InstanceHandle_t DDS_DataWriterProtocolStatus::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.

struct DDS_SequenceNumber_t DDS_DataWriterProtocolStatus::first_unelapsed_keep_duration_sample_sequence_number [read]

The sequence number of the first sample whose keep duration has not yet elapsed. Applicable only when DDS_DataWriterProtocolQosPolicy::disable_positive_acks is set.

Sequence number of the first sample kept in the DataWriter's queue whose keep_duration (applied when DDS_DataWriterProtocolQosPolicy::disable_positive_acks is set) has not yet elapsed.

Applies only for local DataWriter status.