RTI Connext DDS Micro C++ API  Version 4.0.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Sample States

DDS_SampleStateKind and associated elements More...

Typedefs

typedef DDS_UnsignedLong DDS_SampleStateMask
 A bit-mask (list) of sample states, i.e. DDS_SampleStateKind.

Enumerations

enum  DDS_SampleStateKind { DDS_READ_SAMPLE_STATE = 0x0001 << 0, DDS_NOT_READ_SAMPLE_STATE = 0x0001 << 1 }
 Indicates whether or not a sample has ever been read. More...

Variables

const DDS_SampleStateMask DDS_ANY_SAMPLE_STATE
 Any sample state DDS_READ_SAMPLE_STATE | DDS_NOT_READ_SAMPLE_STATE.

Detailed Description

DDS_SampleStateKind and associated elements


Typedef Documentation

A bit-mask (list) of sample states, i.e. DDS_SampleStateKind.


Enumeration Type Documentation

Indicates whether or not a sample has ever been read.

For each sample received, the middleware internally maintains a sample_state relative to each DDSDataReader. The sample state can be either:

The sample state will, in general, be different for each sample in the collection returned by read or take.

Enumerator:
DDS_READ_SAMPLE_STATE 

Sample has been read.

DDS_NOT_READ_SAMPLE_STATE 

Sample has not been read.


Variable Documentation

const DDS_SampleStateMask DDS_ANY_SAMPLE_STATE

RTI Connext DDS Micro C++ API Version 4.0.1 Copyright © Mon Jun 3 2024 Real-Time Innovations, Inc