Reasons why a sample was rejected. More...

#include <State.hpp>

Inherits std::bitset< OMG_DDS_STATE_BIT_COUNT >.

Public Member Functions
	SampleRejectedState ()
	Creates not_lost() More...

	SampleRejectedState (const MaskType &src)
	Create from a bitset. More...

Static Public Member Functions
static const SampleRejectedState	not_rejected ()
	The sample was not rejected. More...

static const SampleRejectedState	rejected_by_samples_limit ()
	When using dds::core::policy::ReliabilityKind_def::RELIABLE: A resource limit on the number of samples (dds::core::policy::ResourceLimits::max_samples) was reached. When using dds::core::policy::ReliabilityKind_def::BEST_EFFORT, reaching dds::core::policy::ResourceLimits::max_samples will trigger a loss, not a rejection, with reason rti::core::status::SampleLostState::lost_by_samples_limit(). More...

static const SampleRejectedState	rejected_by_instances_limit ()
	Connext DDS does not reject samples based on instance limits (dds::core::policy::ResourceLimits::max_instances), so this value will never be used. More...

static const SampleRejectedState	rejected_by_samples_per_instance_limit ()
	When using dds::core::policy::ReliabilityKind_def::RELIABLE: A resource limit on the number of samples per instance (dds::core::policy::ResourceLimits::max_samples_per_instance) was reached. When using dds::core::policy::ReliabilityKind_def::BEST_EFFORT, reaching dds::core::policy::ResourceLimits::max_samples_per_instance will trigger a loss, not a rejection, with reason rti::core::status::SampleLostState::lost_by_samples_per_instance_limit(). More...

static const SampleRejectedState	rejected_by_samples_per_remote_writer_limit ()
	When using dds::core::policy::ReliabilityKind_def::RELIABLE: a resource limit on the number of samples from a given remote writer that a dds::sub::DataReader may store (rti::core::policy::DataReaderResourceLimits::max_samples_per_remote_writer) was reached. When using dds::core::policy::ReliabilityKind_def::BEST_EFFORT, reaching rti::core::policy::DataReaderResourceLimits::max_samples_per_remote_writer will trigger a loss, not a rejection, with reason rti::core::status::SampleLostState::lost_by_samples_per_remote_writer_limit(). More...

static const SampleRejectedState	rejected_by_remote_writers_per_virtual_queue_limit ()
	A resource limit on the number of samples published by a remote writer on behalf of a virtual writer that a dds::sub::DataReader may store was reached. (This field is currently not used.) More...

static const SampleRejectedState	rejected_by_decode_failure ()
	When using dds::core::policy::ReliabilityKind_def::RELIABLE: A received sample was rejected because it could not be decoded. When using dds::core::policy::ReliabilityKind_def::BEST_EFFORT, the sample will be lost, not rejected, with reason rti::core::status::SampleLostState::lost_by_decode_failure(). More...

Detailed Description

Reasons why a sample was rejected.

See also: dds::core::status::SampleRejectedStatus::last_reason()

Constructor & Destructor Documentation

◆ SampleRejectedState() [1/2]

dds::core::status::SampleRejectedState::SampleRejectedState ( )

inline

Creates not_lost()

Referenced by not_rejected(), rejected_by_decode_failure(), rejected_by_instances_limit(), rejected_by_remote_writers_per_virtual_queue_limit(), rejected_by_samples_limit(), rejected_by_samples_per_instance_limit(), and rejected_by_samples_per_remote_writer_limit().

◆ SampleRejectedState() [2/2]

dds::core::status::SampleRejectedState::SampleRejectedState ( const MaskType & src )

inline

Create from a bitset.

Member Function Documentation

◆ not_rejected()

static const SampleRejectedState dds::core::status::SampleRejectedState::not_rejected ( )

inlinestatic

The sample was not rejected.

References SampleRejectedState().

◆ rejected_by_samples_limit()

static const SampleRejectedState dds::core::status::SampleRejectedState::rejected_by_samples_limit ( )

inlinestatic

When using dds::core::policy::ReliabilityKind_def::RELIABLE: A resource limit on the number of samples (dds::core::policy::ResourceLimits::max_samples) was reached. When using dds::core::policy::ReliabilityKind_def::BEST_EFFORT, reaching dds::core::policy::ResourceLimits::max_samples will trigger a loss, not a rejection, with reason rti::core::status::SampleLostState::lost_by_samples_limit().

See also: dds::core::policy::ResourceLimits

References SampleRejectedState().

◆ rejected_by_instances_limit()

static const SampleRejectedState dds::core::status::SampleRejectedState::rejected_by_instances_limit ( )

inlinestatic

Connext DDS does not reject samples based on instance limits (dds::core::policy::ResourceLimits::max_instances), so this value will never be used.

See also: rti::core::status::SampleLostState::lost_by_instances_limit()

References SampleRejectedState().

◆ rejected_by_samples_per_instance_limit()

static const SampleRejectedState dds::core::status::SampleRejectedState::rejected_by_samples_per_instance_limit ( )

inlinestatic

When using dds::core::policy::ReliabilityKind_def::RELIABLE: A resource limit on the number of samples per instance (dds::core::policy::ResourceLimits::max_samples_per_instance) was reached. When using dds::core::policy::ReliabilityKind_def::BEST_EFFORT, reaching dds::core::policy::ResourceLimits::max_samples_per_instance will trigger a loss, not a rejection, with reason rti::core::status::SampleLostState::lost_by_samples_per_instance_limit().

See also: ResourceLimitsQosPolicy

References SampleRejectedState().

◆ rejected_by_samples_per_remote_writer_limit()

static const SampleRejectedState dds::core::status::SampleRejectedState::rejected_by_samples_per_remote_writer_limit ( )

inlinestatic

When using dds::core::policy::ReliabilityKind_def::RELIABLE: a resource limit on the number of samples from a given remote writer that a dds::sub::DataReader may store (rti::core::policy::DataReaderResourceLimits::max_samples_per_remote_writer) was reached. When using dds::core::policy::ReliabilityKind_def::BEST_EFFORT, reaching rti::core::policy::DataReaderResourceLimits::max_samples_per_remote_writer will trigger a loss, not a rejection, with reason rti::core::status::SampleLostState::lost_by_samples_per_remote_writer_limit().

See also: rti::core::policy::DataReaderResourceLimits

References SampleRejectedState().

◆ rejected_by_remote_writers_per_virtual_queue_limit()

static const SampleRejectedState dds::core::status::SampleRejectedState::rejected_by_remote_writers_per_virtual_queue_limit ( )

inlinestatic

A resource limit on the number of samples published by a remote writer on behalf of a virtual writer that a dds::sub::DataReader may store was reached. (This field is currently not used.)