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

typedef DDS_UnsignedLong DDS_SampleStateMask

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

Enumeration Type Documentation

enum DDS_SampleStateKind

Indicates whether or not a sample has ever been read.

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

• DDS_READ_SAMPLE_STATE indicates that the DDS_DataReader has already accessed that sample by means of a read or take operation.

• DDS_NOT_READ_SAMPLE_STATE indicates that the DDS_DataReader has not accessed that sample before.

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

Any sample state DDS_READ_SAMPLE_STATE | DDS_NOT_READ_SAMPLE_STATE.

Examples:

HelloWorld_subscriber.c.