RTI Connext Modern C++ API  Version 6.0.0
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::core::status::DataWriterProtocolStatus Class Reference

<<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.
 
EventCount64 pushed_sample_bytes () const
 The number of bytes of user samples pushed on write from a local DataWriter to a matching remote DataReader.
 
EventCount64 sent_heartbeat_count () const
 The number of Heartbeats sent between a local DataWriter and matching remote DataReader.
 
EventCount64 sent_heartbeat_bytes () const
 The number of bytes of Heartbeats sent between a local DataWriter and matching remote DataReader.
 
EventCount64 pulled_sample_count () const
 The number of user samples pulled from local DataWriter by matching DataReaders.
 
EventCount64 pulled_sample_bytes () const
 The number of bytes of user samples pulled from local DataWriter by matching DataReaders.
 
EventCount64 received_ack_count () const
 The number of ACKs from a remote DataReader received by a local DataWriter.
 
EventCount64 received_ack_bytes () const
 The number of bytes of ACKs from a remote DataReader received by a local DataWriter.
 
EventCount64 received_nack_count () const
 The number of NACKs from a remote DataReader received by a local DataWriter.
 
EventCount64 received_nack_bytes () const
 The number of bytes of NACKs from a remote DataReader received by a local DataWriter.
 
EventCount64 sent_gap_count () const
 The number of GAPs sent from local DataWriter to matching remote DataReaders.
 
EventCount64 sent_gap_bytes () const
 The number of bytes of GAPs sent from local DataWriter to matching remote DataReaders.
 
EventCount64 rejected_sample_count () const
 The number of times a sample is rejected due to exceptions in the send path.
 
int32_t send_window_size () const
 Current maximum number of outstanding samples allowed in the DataWriter's queue.
 
rti::core::SequenceNumber first_available_sample_sequence_number () const
 The sequence number of the first available sample currently queued in the local DataWriter.
 
rti::core::SequenceNumber last_available_sample_sequence_number () const
 The sequence number of the last available sample currently queued in the local DataWriter.
 
rti::core::SequenceNumber first_unacknowledged_sample_sequence_number () const
 The sequence number of the first unacknowledged sample currently queued in the local DataWriter.
 
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.
 
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.
 
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.
 
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.
 
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.
 

Detailed Description

Member Function Documentation

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.

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.

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

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.

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.

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.

For large data, counts whole samples, not fragments.

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.

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

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

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

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.

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

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

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.

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

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

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

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

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

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

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.

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.

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.

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.

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.

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.

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.

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.

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.


RTI Connext Modern C++ API Version 6.0.0 Copyright © Sun Mar 3 2019 Real-Time Innovations, Inc