OpenSplice Java 5 DCPS  v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
org.omg.dds.sub.InstanceState Enum Reference

For each instance the Data Distribution Service internally maintains an InstanceState. More...

Collaboration diagram for org.omg.dds.sub.InstanceState:
Collaboration graph

Public Attributes

 ALIVE =(0x0001 << 0)
 ALIVE indicates that: More...
 
 NOT_ALIVE_DISPOSED =(0x0001 << 1)
 NOT_ALIVE_DISPOSED indicates the instance was disposed of by a DataWriter either explicitly by means of the org.omg.dds.pub.DataWriter#dispose(org.omg.dds.core.InstanceHandle) operation or implicitly in case the autodisposeUnregisteredInstances field of the org.omg.dds.core.policy.WriterDataLifecycle equals TRUE when the instance gets unregistered and no new samples for that instance have been written afterwards. More...
 
 NOT_ALIVE_NO_WRITERS =(0x0001 << 2)
 NOT_ALIVE_NO_WRITERS indicates the instance has been declared as not-alive by the DataReader because it detected that there are no live DataWriter objects writing that instance. More...
 
final int value
 

Detailed Description

For each instance the Data Distribution Service internally maintains an InstanceState.

The InstanceState can be:

  • ALIVE
  • NOT_ALIVE_DISPOSED
  • NOT_ALIVE_NO_WRITERS

The precise events that cause the InstanceState to change depends on the setting of the org.omg.dds.core.policy.Ownership:

  • If OwnershipQosPolicy is set to EXCLUSIVE, then the InstanceState becomes NOT_ALIVE_DISPOSED only if the DataWriter that "owns" the instance explicitly disposes of it. The instanceState becomes ALIVE again only if the DataWriter that owns the instance writes it.
  • If OwnershipQosPolicy is set to SHARED, then the instanceState becomes NOT_ALIVE_DISPOSED if any DataWriter explicitly disposes of the instance. The instanceState becomes ALIVE as soon as any DataWriter writes the instance again.

Definition at line 42 of file InstanceState.java.

Member Data Documentation

◆ ALIVE

org.omg.dds.sub.InstanceState.ALIVE =(0x0001 << 0)

ALIVE indicates that:

  • samples have been received for the instance
  • there are live DataWriter objects writing the instance
  • the instance has not been explicitly disposed of (or else samples have been received after it was disposed of)

Definition at line 54 of file InstanceState.java.

◆ NOT_ALIVE_DISPOSED

org.omg.dds.sub.InstanceState.NOT_ALIVE_DISPOSED =(0x0001 << 1)

NOT_ALIVE_DISPOSED indicates the instance was disposed of by a DataWriter either explicitly by means of the org.omg.dds.pub.DataWriter#dispose(org.omg.dds.core.InstanceHandle) operation or implicitly in case the autodisposeUnregisteredInstances field of the org.omg.dds.core.policy.WriterDataLifecycle equals TRUE when the instance gets unregistered and no new samples for that instance have been written afterwards.

Definition at line 61 of file InstanceState.java.

◆ NOT_ALIVE_NO_WRITERS

org.omg.dds.sub.InstanceState.NOT_ALIVE_NO_WRITERS =(0x0001 << 2)

NOT_ALIVE_NO_WRITERS indicates the instance has been declared as not-alive by the DataReader because it detected that there are no live DataWriter objects writing that instance.

Definition at line 66 of file InstanceState.java.

◆ value

final int org.omg.dds.sub.InstanceState.value

Definition at line 74 of file InstanceState.java.


The documentation for this enum was generated from the following file: