RTI Connext Traditional C++ API Version 7.1.0

<<extension>> Flags for samples. More...

Typedefs

typedef enum DDS_SampleFlagBits DDS_SampleFlagBits
 Type to identify the sample flags reserved by RTI. More...
 
typedef DDS_Long DDS_SampleFlag
 A set of flags that can be associated with a sample. More...
 

Enumerations

enum  DDS_SampleFlagBits {
  DDS_REDELIVERED_SAMPLE ,
  DDS_INTERMEDIATE_REPLY_SEQUENCE_SAMPLE ,
  DDS_REPLICATE_SAMPLE ,
  DDS_LAST_SHARED_READER_QUEUE_SAMPLE ,
  DDS_INTERMEDIATE_TOPIC_QUERY_SAMPLE ,
  DDS_WRITER_REMOVED_BATCH_SAMPLE = PRES_WRITER_REMOVED_BATCH_SAMPLE ,
  DDS_DISCOVERY_SERVICE_SAMPLE = PRES_DISCOVERY_SERVICE_SAMPLE
}
 Type to identify the sample flags reserved by RTI. More...
 

Detailed Description

<<extension>> Flags for samples.

Typedef Documentation

◆ DDS_SampleFlagBits

Type to identify the sample flags reserved by RTI.

◆ DDS_SampleFlag

A set of flags that can be associated with a sample.

  • Least-significant bits [0-7] are reserved by RTI
  • Least-significant bits [8-15] are application specific
  • Least-significant bits [16-31] are invalid and cannot be used

Enumeration Type Documentation

◆ DDS_SampleFlagBits

Type to identify the sample flags reserved by RTI.

Enumerator
DDS_REDELIVERED_SAMPLE 

Indicates that a sample has been redelivered by RTI Queuing Service.

DDS_INTERMEDIATE_REPLY_SEQUENCE_SAMPLE 

Indicates that a response sample is not the last response sample for a given request. This bit is usually set by Connext Repliers sending multiple responses for a request.

DDS_REPLICATE_SAMPLE 

Indicates if a sample must be broadcast by one RTI Queuing Service replica to other replicas.

DDS_LAST_SHARED_READER_QUEUE_SAMPLE 

Indicates that a sample is the last sample in a SharedReaderQueue for a QueueConsumer DataReader.

DDS_INTERMEDIATE_TOPIC_QUERY_SAMPLE 

Indicates that a sample for a TopicQuery will be followed by more samples.

This flag only applies to samples that have been published as a response to a DDSTopicQuery.

When this bit is not set and DDS_SampleInfo::topic_query_guid is different from DDS_GUID_UNKNOWN, this sample is the last sample for that TopicQuery coming from the DataWriter identified by DDS_SampleInfo::original_publication_virtual_guid.

DDS_WRITER_REMOVED_BATCH_SAMPLE 

This flag will be set if the sample was accepted into the DataReader queue even though it was marked by the DataWriter as removed.

A sample can be marked as removed by the DataWriter in a batch when it is replaced due to the DDS_KEEP_LAST_HISTORY_QOS DDS_HistoryQosPolicy QoS or because the duration in DDS_LifespanQosPolicy was reached.

If the DataReader sets the property "dds.data_reader.accept_writer_removed_batch_samples" to true, the removed sample will be accepted into the DataReader queue and this flag will be set.

DDS_DISCOVERY_SERVICE_SAMPLE 

This flag will be set if the sample was sent by Cloud Discovery Service.

The samples sent by Cloud Discovery Service are participant announcement samples on the ParticipantBuiltinTopic.