RTI Connext .NET API (legacy)  Version 6.1.2
DDS::InstanceStateKind Struct Reference

Indicates if the samples are from a live DDS::DataWriter or not. More...

#include <managed_subscription.h>

Properties

static InstanceStateKind ALIVE_INSTANCE_STATE [get]
 Instance is currently in existence. More...
 
static InstanceStateKind NOT_ALIVE_DISPOSED_INSTANCE_STATE [get]
 Not alive disposed instance. The instance has been disposed by a DataWriter. More...
 
static InstanceStateKind NOT_ALIVE_NO_WRITERS_INSTANCE_STATE [get]
 Not alive no writers for instance. None of the DDS::DataWriter objects that are currently alive (according to the LIVELINESS) are writing the instance. More...
 
static InstanceStateKind ANY_INSTANCE_STATE [get]
 Any instance state ALIVE_INSTANCE_STATE | NOT_ALIVE_DISPOSED_INSTANCE_STATE | NOT_ALIVE_NO_WRITERS_INSTANCE_STATE. More...
 
static InstanceStateKind NOT_ALIVE_INSTANCE_STATE [get]
 Not alive instance state NOT_ALIVE_DISPOSED_INSTANCE_STATE | NOT_ALIVE_NO_WRITERS_INSTANCE_STATE. More...
 

Detailed Description

Indicates if the samples are from a live DDS::DataWriter or not.

For each instance, the middleware internally maintains an instance state. The instance state can be:

  • DDS::InstanceStateKind::ALIVE_INSTANCE_STATE indicates that (a) samples have been received for the instance, (b) there are live DDS::DataWriter entities writing the instance, and (c) the instance has not been explicitly disposed (or else more samples have been received after it was disposed).

The precise behavior events that cause the instance state to change depends on the setting of the OWNERSHIP QoS:

The instance state available in the DDS::SampleInfo is a snapshot of the instance state of the instance at the time the collection was obtained (i.e. at the time read or take was called). The instance state is therefore the same for all samples in the returned collection that refer to the same instance.

Property Documentation

◆ ALIVE_INSTANCE_STATE

InstanceStateKind DDS::InstanceStateKind::ALIVE_INSTANCE_STATE
staticget

Instance is currently in existence.

◆ NOT_ALIVE_DISPOSED_INSTANCE_STATE

InstanceStateKind DDS::InstanceStateKind::NOT_ALIVE_DISPOSED_INSTANCE_STATE
staticget

Not alive disposed instance. The instance has been disposed by a DataWriter.

◆ NOT_ALIVE_NO_WRITERS_INSTANCE_STATE

InstanceStateKind DDS::InstanceStateKind::NOT_ALIVE_NO_WRITERS_INSTANCE_STATE
staticget

Not alive no writers for instance. None of the DDS::DataWriter objects that are currently alive (according to the LIVELINESS) are writing the instance.