RTI Connext Modern C++ API  Version 5.3.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
rti::pub::AcknowledgmentInfo Class Reference

<<extension>> <<value-type>> Information about an application-acknowledged sample More...

#include <AcknowledgmentInfo.hpp>

Public Member Functions

dds::core::InstanceHandle subscription_handle () const
 Gets the subscription handle of the acknowledging dds::sub::DataReader.
 
rti::core::SampleIdentity sample_identity () const
 Gets the identity of the sample being acknowledged.
 
bool valid_response_data () const
 Flag indicating validity of the user response data in the acknowledgment.
 
rti::sub::AckResponseData response_data () const
 User data payload of application-level acknowledgment message.
 

Detailed Description

<<extension>> <<value-type>> Information about an application-acknowledged sample

When acknowledging a sample, the reader provides the writer with information about the sample being acknowledged. The AcknowledgmentInfo structure provides the identity and cookie of the sample being acknowledged, as well as user data payload provided by the reader.

Member Function Documentation

dds::core::InstanceHandle rti::pub::AcknowledgmentInfo::subscription_handle ( ) const

Gets the subscription handle of the acknowledging dds::sub::DataReader.

rti::core::SampleIdentity rti::pub::AcknowledgmentInfo::sample_identity ( ) const

Gets the identity of the sample being acknowledged.

See Also
rti::core::SampleIdentity
bool rti::pub::AcknowledgmentInfo::valid_response_data ( ) const

Flag indicating validity of the user response data in the acknowledgment.

This flag is true when the rti::core::RtpsReliableReaderProtocol::min_app_ack_response_keep_duration has not yet elapsed for the acknowledgment's response data.

The flag is false when that duration has elapsed for the response data.

rti::sub::AckResponseData rti::pub::AcknowledgmentInfo::response_data ( ) const

User data payload of application-level acknowledgment message.

Response data set by dds::sub::DataReader when sample was acknowledged.


RTI Connext Modern C++ API Version 5.3.1 Copyright © Mon Feb 19 2018 Real-Time Innovations, Inc