OpenSplice ISO C++ 2 DCPS  v6.x
ISO C++ 2 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
dds::core::status::SampleRejectedStatus Class Reference

More...

#include "Status.hpp"

Inheritance diagram for dds::core::status::SampleRejectedStatus:
Inheritance graph

Public Member Functions

 SampleRejectedStatus ()
 
const dds::core::InstanceHandle last_instance_handle () const
 
const dds::core::status::SampleRejectedState last_reason () const
 
bool operator!= (const Value &other) const
 
D * operator-> ()
 
const D * operator-> () const
 
bool operator== (const Value &other) const
 
int32_t total_count () const
 
int32_t total_count_change () const
 

Detailed Description

Attribute Attribute Meaning
total_count Total cumulative count of samples rejected by the DataReader.
total_count_change The incremental number of samples rejected since the last time the listener was called or the status was read.
last_reason Reason for rejecting the last sample rejected. If no samples have been rejected, the reason is the special value NOT_REJECTED.
last_instance_handle Handle to the instance being updated by the last sample that was rejected.

A received sample was rejected. This can happen when the ResourceLimits Qos is active and the History determined by History QoS of the DataReader is full.

Definition at line 85 of file Status.hpp.

Constructor & Destructor Documentation

◆ SampleRejectedStatus()

dds::core::status::SampleRejectedStatus::SampleRejectedStatus ( )

Definition at line 78 of file StatusImpl.hpp.

Member Function Documentation

◆ last_instance_handle()

const dds::core::InstanceHandle dds::core::status::SampleRejectedStatus::last_instance_handle ( ) const
Returns
Handle to the instance being updated by the last sample that was rejected.

Definition at line 99 of file StatusImpl.hpp.

◆ last_reason()

const dds::core::status::SampleRejectedState dds::core::status::SampleRejectedStatus::last_reason ( ) const
Returns
Reason for rejecting the last sample rejected. If no samples have been rejected, the reason is the special value NOT_REJECTED.

Definition at line 93 of file StatusImpl.hpp.

◆ operator!=()

template<typename D >
bool dds::core::Value< D >::operator!= ( const Value< D > &  other) const
inherited

Compare this Value with another Value

Parameters
otherValue
Returns
true if not equal

Definition at line 99 of file Value.hpp.

◆ operator->() [1/2]

template<typename D >
D * dds::core::Value< D >::operator-> ( )
inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();
Returns
a reference to delegate.

Definition at line 111 of file Value.hpp.

◆ operator->() [2/2]

template<typename D >
const D * dds::core::Value< D >::operator-> ( ) const
inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();
Returns
a reference to delegate.

Definition at line 105 of file Value.hpp.

◆ operator==()

template<typename D >
bool dds::core::Value< D >::operator== ( const Value< D > &  other) const
inherited

Compare this Value with another Value

Parameters
otherValue
Returns
true if equal

Definition at line 93 of file Value.hpp.

◆ total_count()

int32_t dds::core::status::SampleRejectedStatus::total_count ( ) const
Returns
Total cumulative count of samples rejected by the DataReader.

Definition at line 81 of file StatusImpl.hpp.

◆ total_count_change()

int32_t dds::core::status::SampleRejectedStatus::total_count_change ( ) const
Returns
The incremental number of samples rejected since the last time the listener was called or the status was read.

Definition at line 87 of file StatusImpl.hpp.


The documentation for this class was generated from the following files: