<<extension>> Information about the status dds::core::status::StatusMask::datawriter_protocol() More...

#include <Status.hpp>

Inherits rti::core::NativeValueType< T, NATIVE_T, ADAPTER >.

Public Member Functions
EventCount64	pushed_sample_count () const
	The number of user samples pushed on write from a local DataWriter to a matching remote DataReader. More...

EventCount64	pushed_sample_bytes () const
	The number of bytes of user samples pushed on write from a local DataWriter to a matching remote DataReader. More...

EventCount64	filtered_sample_count () const
	[Not supported.] The number of user samples preemptively filtered by a local DataWriter due to Content-Filtered Topics. More...

EventCount64	filtered_sample_bytes () const
	[Not supported.] The number of bytes of user samples preemptively filtered by a local DataWriter due to Content-Filtered Topics. More...

EventCount64	sent_heartbeat_count () const
	The number of Heartbeats sent between a local DataWriter and matching remote DataReader. More...

EventCount64	sent_heartbeat_bytes () const
	The number of bytes of Heartbeats sent between a local DataWriter and matching remote DataReader. More...

EventCount64	pulled_sample_count () const
	The number of user samples pulled from local DataWriter by matching DataReaders. More...

EventCount64	pulled_sample_bytes () const
	The number of bytes of user samples pulled from local DataWriter by matching DataReaders. More...

EventCount64	received_ack_count () const
	The number of ACKs from a remote DataReader received by a local DataWriter. More...

EventCount64	received_ack_bytes () const
	The number of bytes of ACKs from a remote DataReader received by a local DataWriter. More...

EventCount64	received_nack_count () const
	The number of NACKs from a remote DataReader received by a local DataWriter. More...

EventCount64	received_nack_bytes () const
	The number of bytes of NACKs from a remote DataReader received by a local DataWriter. More...

EventCount64	sent_gap_count () const
	The number of GAPs sent from local DataWriter to matching remote DataReaders. More...

EventCount64	sent_gap_bytes () const
	The number of bytes of GAPs sent from local DataWriter to matching remote DataReaders. More...

EventCount64	rejected_sample_count () const
	[Not supported.] More...

int32_t	send_window_size () const
	Current maximum number of outstanding samples allowed in the DataWriter's queue. More...

rti::core::SequenceNumber	first_available_sample_sequence_number () const
	The sequence number of the first available sample currently queued in the local DataWriter. More...

rti::core::SequenceNumber	last_available_sample_sequence_number () const
	The sequence number of the last available sample currently queued in the local DataWriter. More...

rti::core::SequenceNumber	first_unacknowledged_sample_sequence_number () const
	The sequence number of the first unacknowledged sample currently queued in the local DataWriter. More...

rti::core::SequenceNumber	first_available_sample_virtual_sequence_number () const
	The virtual sequence number of the first available sample currently queued in the local DataWriter. More...

rti::core::SequenceNumber	last_available_sample_virtual_sequence_number () const
	The virtual sequence number of the last available sample currently queued in the local DataWriter. More...

rti::core::SequenceNumber	first_unacknowledged_sample_virtual_sequence_number () const
	The virtual sequence number of the first unacknowledged sample currently queued in the local DataWriter. More...

dds::core::InstanceHandle	first_unacknowledged_sample_subscription_handle () const
	The handle of a remote DataReader that has not acknowledged the first unacknowledged sample of the local DataWriter. More...

rti::core::SequenceNumber	first_unelapsed_keep_duration_sample_sequence_number () const
	The sequence number of the first sample whose keep duration has not yet elapsed. More...

int64_t	pushed_fragment_count () const
	The number of DATA_FRAG messages that have been pushed by this DataWriter. More...

int64_t	pushed_fragment_bytes () const
	The number of bytes of DATA_FRAG messages that have been pushed by this DataWriter. More...

int64_t	pulled_fragment_count () const
	The number of DATA_FRAG messages that have been pulled from this DataWriter. More...

int64_t	pulled_fragment_bytes () const
	The number of bytes of DATA_FRAG messages that have been pulled from this DataWriter. More...

int64_t	received_nack_fragment_count () const
	The number of NACK_FRAG messages that have been received by this DataWriter. More...

int64_t	received_nack_fragment_bytes () const
	The number of bytes of NACK_FRAG messages that have been received by this DataWriter. More...

Detailed Description

<<extension>> Information about the status dds::core::status::StatusMask::datawriter_protocol()

Entity:: dds::pub::DataWriter

Member Function Documentation

◆ pushed_sample_count()

EventCount64 rti::core::status::DataWriterProtocolStatus::pushed_sample_count ( ) const

inline

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. The fragment count is tracked in the rti::core::status::DataWriterProtocolStatus::pushed_fragment_count statistic.

◆ pushed_sample_bytes()

EventCount64 rti::core::status::DataWriterProtocolStatus::pushed_sample_bytes ( ) const

inline

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.

When data fragmentation is used, this statistic is incremented as fragments are written.

◆ filtered_sample_count()

EventCount64 rti::core::status::DataWriterProtocolStatus::filtered_sample_count ( ) const

inline

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

◆ filtered_sample_bytes()

EventCount64 rti::core::status::DataWriterProtocolStatus::filtered_sample_bytes ( ) const

inline

[Not supported.] The number of bytes of user samples preemptively filtered by a local DataWriter due to Content-Filtered Topics.

◆ sent_heartbeat_count()

EventCount64 rti::core::status::DataWriterProtocolStatus::sent_heartbeat_count ( ) const

inline

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.

◆ sent_heartbeat_bytes()

EventCount64 rti::core::status::DataWriterProtocolStatus::sent_heartbeat_bytes ( ) const

inline

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.

◆ pulled_sample_count()

EventCount64 rti::core::status::DataWriterProtocolStatus::pulled_sample_count ( ) const

inline

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 rti::core::policy::DataWriterProtocol::push_on_write is false.

When data fragmentation is used, this statistic is incremented as fragments are written.

◆ pulled_sample_bytes()

EventCount64 rti::core::status::DataWriterProtocolStatus::pulled_sample_bytes ( ) const

inline

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 rti::core::policy::DataWriterProtocol::push_on_write is false.

When data fragmentation is used, this statistic is incremented as fragments are written.

◆ received_ack_count()

EventCount64 rti::core::status::DataWriterProtocolStatus::received_ack_count ( ) const

inline

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

◆ received_ack_bytes()

EventCount64 rti::core::status::DataWriterProtocolStatus::received_ack_bytes ( ) const

inline

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

◆ received_nack_count()

EventCount64 rti::core::status::DataWriterProtocolStatus::received_nack_count ( ) const

inline

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

◆ received_nack_bytes()

EventCount64 rti::core::status::DataWriterProtocolStatus::received_nack_bytes ( ) const

inline

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

◆ sent_gap_count()

EventCount64 rti::core::status::DataWriterProtocolStatus::sent_gap_count ( ) const

inline

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

◆ sent_gap_bytes()

EventCount64 rti::core::status::DataWriterProtocolStatus::sent_gap_bytes ( ) const

inline

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

◆ rejected_sample_count()

EventCount64 rti::core::status::DataWriterProtocolStatus::rejected_sample_count ( ) const

inline

[Not supported.]

◆ send_window_size()

int32_t rti::core::status::DataWriterProtocolStatus::send_window_size ( ) const

inline

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

Spans the range from rti::core::RtpsReliableWriterProtocol::min_send_window_size to rti::core::RtpsReliableWriterProtocol::max_send_window_size.

◆ first_available_sample_sequence_number()

rti::core::SequenceNumber rti::core::status::DataWriterProtocolStatus::first_available_sample_sequence_number ( ) const

inline

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

Applies only for local DataWriter status.

◆ last_available_sample_sequence_number()

rti::core::SequenceNumber rti::core::status::DataWriterProtocolStatus::last_available_sample_sequence_number ( ) const

inline

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

Applies only for local DataWriter status.

◆ first_unacknowledged_sample_sequence_number()

rti::core::SequenceNumber rti::core::status::DataWriterProtocolStatus::first_unacknowledged_sample_sequence_number ( ) const

inline

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

Applies only for local DataWriter status.

◆ first_available_sample_virtual_sequence_number()

rti::core::SequenceNumber rti::core::status::DataWriterProtocolStatus::first_available_sample_virtual_sequence_number ( ) const

inline

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

Applies only for local DataWriter status.

◆ last_available_sample_virtual_sequence_number()

rti::core::SequenceNumber rti::core::status::DataWriterProtocolStatus::last_available_sample_virtual_sequence_number ( ) const

inline

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

Applies only for local DataWriter status.

◆ first_unacknowledged_sample_virtual_sequence_number()

rti::core::SequenceNumber rti::core::status::DataWriterProtocolStatus::first_unacknowledged_sample_virtual_sequence_number ( ) const

inline

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

Applies only for local DataWriter status.

◆ first_unacknowledged_sample_subscription_handle()

dds::core::InstanceHandle rti::core::status::DataWriterProtocolStatus::first_unacknowledged_sample_subscription_handle ( ) const

inline

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

Applies only for local DataWriter status.

◆ first_unelapsed_keep_duration_sample_sequence_number()

rti::core::SequenceNumber rti::core::status::DataWriterProtocolStatus::first_unelapsed_keep_duration_sample_sequence_number ( ) const

inline

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

Applicable only when rti::core::policy::DataWriterProtocol::disable_positive_acks is set.

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

Applies only for local DataWriter status.

◆ pushed_fragment_count()

int64_t rti::core::status::DataWriterProtocolStatus::pushed_fragment_count ( ) const

inline

The number of DATA_FRAG messages that have been pushed by this DataWriter.

This statistic is incremented as each DATA_FRAG message is sent, not when the entire sample has been sent. Applicable only when data is fragmented.

◆ pushed_fragment_bytes()

int64_t rti::core::status::DataWriterProtocolStatus::pushed_fragment_bytes ( ) const

inline

The number of bytes of DATA_FRAG messages that have been pushed by this DataWriter.

This statistic is incremented as each DATA_FRAG message is sent, not when the entire sample has been sent. Applicable only when data is fragmented.

◆ pulled_fragment_count()

int64_t rti::core::status::DataWriterProtocolStatus::pulled_fragment_count ( ) const

inline

The number of DATA_FRAG messages that have been pulled from this DataWriter.

This statistic is incremented as each DATA_FRAG message is sent, not when the entire sample has been sent. Applicable only when data is fragmented.

◆ pulled_fragment_bytes()

int64_t rti::core::status::DataWriterProtocolStatus::pulled_fragment_bytes ( ) const

inline

The number of bytes of DATA_FRAG messages that have been pulled from this DataWriter.

This statistic is incremented as each DATA_FRAG message is sent, not when the entire sample has been sent. Applicable only when data is fragmented.

◆ received_nack_fragment_count()

int64_t rti::core::status::DataWriterProtocolStatus::received_nack_fragment_count ( ) const

inline

The number of NACK_FRAG messages that have been received by this DataWriter.

NACK FRAG RTPS messages are sent when large data is used in conjunction with reliable communication. They have the same properties as NACK messages, but instead of applying to samples, they apply to fragments. Applicable only when data is fragmented.

◆ received_nack_fragment_bytes()

int64_t rti::core::status::DataWriterProtocolStatus::received_nack_fragment_bytes ( ) const

inline

The number of bytes of NACK_FRAG messages that have been received by this DataWriter.

NACK FRAG RTPS messages are sent when large data is used in conjunction with reliable communication. They have the same properties as NACK messages, but instead of applying to samples, they apply to fragments. Applicable only when data is fragmented.

Public Member Functions

Detailed Description

Member Function Documentation

◆ pushed_sample_count()

◆ pushed_sample_bytes()

◆ filtered_sample_count()

◆ filtered_sample_bytes()

◆ sent_heartbeat_count()

◆ sent_heartbeat_bytes()

◆ pulled_sample_count()

◆ pulled_sample_bytes()

◆ received_ack_count()

◆ received_ack_bytes()

◆ received_nack_count()

◆ received_nack_bytes()

◆ sent_gap_count()

◆ sent_gap_bytes()

◆ rejected_sample_count()

◆ send_window_size()

◆ first_available_sample_sequence_number()

◆ last_available_sample_sequence_number()

◆ first_unacknowledged_sample_sequence_number()

◆ first_available_sample_virtual_sequence_number()

◆ last_available_sample_virtual_sequence_number()

◆ first_unacknowledged_sample_virtual_sequence_number()

◆ first_unacknowledged_sample_subscription_handle()

◆ first_unelapsed_keep_duration_sample_sequence_number()

◆ pushed_fragment_count()

◆ pushed_fragment_bytes()

◆ pulled_fragment_count()

◆ pulled_fragment_bytes()

◆ received_nack_fragment_count()

◆ received_nack_fragment_bytes()