RTI Connext C API  Version 6.1.0
DDS_AcknowledgmentInfo Struct Reference

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

Data Fields

DDS_InstanceHandle_t subscription_handle
 Subscription handle of the acknowledging DDS_DataReader. More...
 
struct DDS_SampleIdentity_t sample_identity
 Identity of the sample being acknowledged. More...
 
DDS_Boolean valid_response_data
 Flag indicating validity of the user response data in the acknowledgment. More...
 
struct DDS_AckResponseData_t response_data
 User data payload of application-level acknowledgment message. 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.

Field Documentation

◆ subscription_handle

DDS_InstanceHandle_t DDS_AcknowledgmentInfo::subscription_handle

Subscription handle of the acknowledging DDS_DataReader.

◆ sample_identity

struct DDS_SampleIdentity_t DDS_AcknowledgmentInfo::sample_identity

Identity of the sample being acknowledged.

See also
DDS_SampleIdentity_t

◆ valid_response_data

DDS_Boolean DDS_AcknowledgmentInfo::valid_response_data

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.

◆ response_data

struct DDS_AckResponseData_t DDS_AcknowledgmentInfo::response_data

User data payload of application-level acknowledgment message.

Response data set by DDS_DataReader when sample was acknowledged.