RTI Connext .NET API (legacy)  Version 6.1.0
DDS::AcknowledgmentInfo Class Reference

Information about an application-level acknowledged sample. More...

#include <managed_infrastructure.h>

Public Attributes

InstanceHandle_t subscription_handle
 Subscription handle of the acknowledging DDS::DataReader. More...
 
SampleIdentity_t sample_identity
 Identity of the sample being acknowledged. More...
 
AckResponseData_tresponse_data
 User data payload of application-level acknowledgment message. More...
 

Properties

System::Boolean valid_response_data [get, set]
 Flag indicating validity of the user response data in the acknowledgment. More...
 

Detailed Description

Information about an application-level 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 Data Documentation

◆ subscription_handle

InstanceHandle_t DDS::AcknowledgmentInfo::subscription_handle

Subscription handle of the acknowledging DDS::DataReader.

◆ sample_identity

SampleIdentity_t DDS::AcknowledgmentInfo::sample_identity

Identity of the sample being acknowledged.

See also
DDS::SampleIdentity_t

Referenced by RTI.Connext.Queuing.QueueProducer< TRep >::CreateWriteSample().

◆ response_data

AckResponseData_t ^ DDS::AcknowledgmentInfo::response_data

User data payload of application-level acknowledgment message.

Response data set by DDS::DataReader when sample was acknowledged.

Referenced by RTI.Connext.Queuing.QueueProducer< TRep >::CreateWriteSample().

Property Documentation

◆ valid_response_data

System:: Boolean DDS::AcknowledgmentInfo::valid_response_data
getset

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

This flag is true when the DDS::RtpsReliableReaderProtocol_t::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.