rti::core::SampleFlag Class Reference

<<extension>> A set of flags that can be associated with a sample. More...

#include "rti/core/SampleFlag.hpp"

Inherits std::bitset< 32 >.

Public Types
typedef std::bitset< 32 >	MaskType
	A typedef of std::bitset<32> for convenience. More...

Public Member Functions
	SampleFlag ()
	Construct an empty SampleFlag with no bits set. More...
	SampleFlag (uint64_t mask)
	Construct a SampleFlag from an integer. More...
	SampleFlag (const MaskType &mask)
	Construct a SampleFlag from a MaskType object. More...

Static Public Member Functions
static const SampleFlag	redelivered ()
	Indicates that a sample has been redelivered by RTI Queuing Service. More...
static const SampleFlag	intermediate_reply_sequence ()
	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. More...
static const SampleFlag	replicate ()
	Indicates if a sample must be broadcast by one RTI Queuing Service replica to other replicas. More...
static const SampleFlag	last_shared_reader_queue ()
	Indicates that a sample is the last sample in a SharedReaderQueue for a QueueConsumer DataReader. More...
static const SampleFlag	intermediate_topic_query_sample ()
	Indicates that a sample for a TopicQuery will be followed by more samples. More...
static const SampleFlag	writer_removed_batch_sample ()
	This flag will be set if a sample was accepted into the DataReader queue even though it was marked by the DataWriter as removed. More...
static const SampleFlag	discovery_service_sample ()
	This flag will be set if the sample was sent by Cloud Discovery Service. More...

Detailed Description

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

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

Member Typedef Documentation

MaskType

typedef std::bitset<32> rti::core::SampleFlag::MaskType

A typedef of std::bitset<32> for convenience.

Constructor & Destructor Documentation

SampleFlag() [1/3]

rti::core::SampleFlag::SampleFlag ( )

inline

Construct an empty SampleFlag with no bits set.

SampleFlag() [2/3]

rti::core::SampleFlag::SampleFlag ( uint64_t  mask )

inlineexplicit

Construct a SampleFlag from an integer.

Parameters

mask	Value whose bits are copied to the bitset positions

SampleFlag() [3/3]

rti::core::SampleFlag::SampleFlag ( const MaskType &  mask )

inline

Construct a SampleFlag from a MaskType object.

Parameters

mask	A std::bitset<32> to construct this SampleFlag from

Member Function Documentation

redelivered()

static const SampleFlag rti::core::SampleFlag::redelivered ( )

inlinestatic

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

intermediate_reply_sequence()

static const SampleFlag rti::core::SampleFlag::intermediate_reply_sequence ( )

inlinestatic

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.

replicate()

static const SampleFlag rti::core::SampleFlag::replicate ( )

inlinestatic

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

last_shared_reader_queue()

static const SampleFlag rti::core::SampleFlag::last_shared_reader_queue ( )

inlinestatic

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

intermediate_topic_query_sample()

static const SampleFlag rti::core::SampleFlag::intermediate_topic_query_sample ( )

inlinestatic

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 rti::sub::TopicQuery.

When this bit is not set and dds::sub::SampleInfo::topic_query_guid is different from rti::core::Guid::unknown(), this sample is the last sample for that TopicQuery coming from the DataWriter identified by dds::sub::SampleInfo::original_publication_virtual_guid.

writer_removed_batch_sample()

static const SampleFlag rti::core::SampleFlag::writer_removed_batch_sample ( )

inlinestatic

This flag will be set if a 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 KEEP_LAST_HISTORY_QOS QoS or because the duration in 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.

A sample can be marked as removed by the DataWriter in a batch when it is replaced due to the dds::core::policy::HistoryKind::KEEP_LAST dds::core::policy::History QoS or because the duration in dds::core::policy::Lifespan 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.

discovery_service_sample()

static const SampleFlag rti::core::SampleFlag::discovery_service_sample ( )

inlinestatic

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.