OpenSplice Java 5 DCPS  v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
org.omg.dds.core.status.LivelinessChangedStatus Class Referenceabstract

The liveliness of one or more org.omg.dds.pub.DataWriters that were writing instances read through the org.omg.dds.sub.DataReader has changed. More...

Inheritance diagram for org.omg.dds.core.status.LivelinessChangedStatus:
Inheritance graph
Collaboration diagram for org.omg.dds.core.status.LivelinessChangedStatus:
Collaboration graph

Public Member Functions

abstract int getAliveCount ()
 The total number of currently active org.omg.dds.pub.DataWriters that write the Topic read by the org.omg.dds.sub.DataReader. More...
 
abstract int getAliveCountChange ()
 The change in the aliveCount since the last time the listener was called or the status was read. More...
 
ServiceEnvironment getEnvironment ()
 
abstract InstanceHandle getLastPublicationHandle ()
 Handle to the last org.omg.dds.pub.DataWriter whose change in liveliness caused this status to change. More...
 
abstract int getNotAliveCount ()
 The total count of currently org.omg.dds.pub.DataWriters that write the org.omg.dds.topic.Topic read by the org.omg.dds.sub.DataReader that are no longer asserting their liveliness. More...
 
abstract int getNotAliveCountChange ()
 The change in the notAliveCount since the last time the listener was called or the status was read. More...
 

Static Public Member Functions

static Set< Class<? extends Status > > allStatuses (ServiceEnvironment env)
 
static Set< Class<? extends Status > > noStatuses (ServiceEnvironment env)
 

Detailed Description

The liveliness of one or more org.omg.dds.pub.DataWriters that were writing instances read through the org.omg.dds.sub.DataReader has changed.

Some DataWriter(s) have become "active" or "inactive."

See also
org.omg.dds.core.event.LivelinessChangedEvent
LivelinessLostStatus

Definition at line 32 of file LivelinessChangedStatus.java.

Member Function Documentation

◆ allStatuses()

static Set<Class<? extends Status> > org.omg.dds.core.status.Status.allStatuses ( ServiceEnvironment  env)
staticinherited
Parameters
envIdentifies the Service instance to which the object will belong.

Definition at line 59 of file Status.java.

◆ getAliveCount()

abstract int org.omg.dds.core.status.LivelinessChangedStatus.getAliveCount ( )
abstract

The total number of currently active org.omg.dds.pub.DataWriters that write the Topic read by the org.omg.dds.sub.DataReader.

This count increases when a newly matched DataWriter asserts its liveliness for the first time or when a DataWriter previously considered to be not alive reasserts its liveliness. The count decreases when a DataWriter considered alive fails to assert its liveliness and becomes not alive, whether because it was deleted normally or for some other reason.

◆ getAliveCountChange()

abstract int org.omg.dds.core.status.LivelinessChangedStatus.getAliveCountChange ( )
abstract

The change in the aliveCount since the last time the listener was called or the status was read.

◆ getEnvironment()

ServiceEnvironment org.omg.dds.core.DDSObject.getEnvironment ( )
inherited
Returns
the org.omg.dds.core.ServiceEnvironment object that directly or indirectly was used to create this object.

Implemented in org.omg.dds.core.ServiceEnvironment, org.opensplice.dds.sub.ReflectionDataReader< TYPE, OUT_TYPE >, org.opensplice.dds.core.ModifiableTimeImpl, org.opensplice.dds.pub.ReflectionDataWriter< TYPE >, org.opensplice.dds.core.DurationImpl, org.opensplice.dds.topic.ContentFilteredTopicImpl< TYPE >, org.opensplice.dds.sub.ReadConditionImpl< TYPE >, org.opensplice.dds.core.EntityQosImpl< T extends QosPolicy >, org.opensplice.dds.type.TypeSupportImpl< TYPE >, org.opensplice.dds.topic.PublicationBuiltinTopicDataImpl, org.opensplice.dds.topic.SubscriptionBuiltinTopicDataImpl, org.opensplice.dds.topic.TopicBuiltinTopicDataImpl, org.opensplice.dds.domain.DomainParticipantFactoryImpl, org.opensplice.dds.core.QosProviderImpl, org.opensplice.dds.core.status.OfferedIncompatibleQosStatusImpl, org.opensplice.dds.core.status.RequestedIncompatibleQosStatusImpl, org.opensplice.dds.core.InstanceHandleImpl, org.opensplice.dds.core.StatusConditionImpl< T extends Entity<?, ?>, org.opensplice.dds.core.status.LivelinessChangedStatusImpl, org.opensplice.dds.core.status.PublicationMatchedStatusImpl, org.opensplice.dds.core.status.SubscriptionMatchedStatusImpl, org.opensplice.dds.sub.SampleImpl< TYPE >, org.opensplice.dds.core.policy.ShareImpl, org.opensplice.dds.core.status.OfferedDeadlineMissedStatusImpl, org.opensplice.dds.core.status.SampleRejectedStatusImpl, org.opensplice.dds.core.WaitSetImpl, org.opensplice.dds.topic.ParticipantBuiltinTopicDataImpl, org.opensplice.dds.core.status.RequestedDeadlineMissedStatusImpl, org.opensplice.dds.topic.BuiltinTopicKeyImpl, org.opensplice.dds.core.GuardConditionImpl, org.opensplice.dds.core.event.AllDataDisposedEventImpl< TYPE >, org.opensplice.dds.core.policy.QosPolicyCountImpl, org.opensplice.dds.core.status.InconsistentTopicStatusImpl, org.opensplice.dds.core.status.LivelinessLostStatusImpl, org.opensplice.dds.core.status.SampleLostStatusImpl, org.opensplice.dds.core.policy.QosPolicyImpl, org.opensplice.dds.core.status.AllDataDisposedStatusImpl, org.opensplice.dds.core.IllegalArgumentExceptionImpl, org.opensplice.dds.core.InconsistentPolicyExceptionImpl, org.opensplice.dds.core.policy.PolicyFactoryImpl, org.opensplice.dds.core.policy.TypeConsistencyEnforcementImpl, org.opensplice.dds.core.PreconditionNotMetExceptionImpl, org.opensplice.dds.core.AlreadyClosedExceptionImpl, org.opensplice.dds.core.IllegalOperationExceptionImpl, org.opensplice.dds.core.ImmutablePolicyExceptionImpl, org.opensplice.dds.core.NotEnabledExceptionImpl, org.opensplice.dds.core.OutOfResourcesExceptionImpl, org.opensplice.dds.core.DDSExceptionImpl, org.opensplice.dds.core.status.DataAvailableStatusImpl, and org.opensplice.dds.core.status.DataOnReadersStatusImpl.

◆ getLastPublicationHandle()

abstract InstanceHandle org.omg.dds.core.status.LivelinessChangedStatus.getLastPublicationHandle ( )
abstract

Handle to the last org.omg.dds.pub.DataWriter whose change in liveliness caused this status to change.

contains the instance handle to the org.omg.dds.topic.PublicationBuiltinTopicData instance that represents the last org.omg.dds.pub.DataWriter whose change in liveliness caused this status to change. Be aware that this handle belongs to another datareader, the PublicationBuiltinTopicDataDataReader in the builtin-subscriber, and has no meaning in the context of the datareader from which the LivelinessChangedStatus was obtained. If the builtin-subscriber has not explicitly been obtained using get_builtin_subscriber on the DomainParticipant, then there is no PublicationBuiltinTopicDataDataReader as well, in which case the last_publication_handle will be set to HANDLE_NIL.

◆ getNotAliveCount()

abstract int org.omg.dds.core.status.LivelinessChangedStatus.getNotAliveCount ( )
abstract

The total count of currently org.omg.dds.pub.DataWriters that write the org.omg.dds.topic.Topic read by the org.omg.dds.sub.DataReader that are no longer asserting their liveliness.

This count increases when a DataWriter considered alive fails to assert its liveliness and becomes not alive for some reason other than the normal deletion of that DataWriter. It decreases when a previously not alive DataWriter either reasserts its liveliness or is deleted normally.

◆ getNotAliveCountChange()

abstract int org.omg.dds.core.status.LivelinessChangedStatus.getNotAliveCountChange ( )
abstract

The change in the notAliveCount since the last time the listener was called or the status was read.

◆ noStatuses()

static Set<Class<? extends Status> > org.omg.dds.core.status.Status.noStatuses ( ServiceEnvironment  env)
staticinherited
Parameters
envIdentifies the Service instance to which the object will belong.

Definition at line 70 of file Status.java.


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