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

Status is the abstract root class for all communication status objects. More...

Inherits Serializable, and org.omg.dds.core.DDSObject.

Inherited by org.omg.dds.core.status.DataAvailableStatus, org.omg.dds.core.status.DataOnReadersStatus, org.omg.dds.core.status.InconsistentTopicStatus, org.omg.dds.core.status.LivelinessChangedStatus, org.omg.dds.core.status.LivelinessLostStatus, org.omg.dds.core.status.OfferedDeadlineMissedStatus, org.omg.dds.core.status.OfferedIncompatibleQosStatus, org.omg.dds.core.status.PublicationMatchedStatus, org.omg.dds.core.status.RequestedDeadlineMissedStatus, org.omg.dds.core.status.RequestedIncompatibleQosStatus, org.omg.dds.core.status.SampleLostStatus, org.omg.dds.core.status.SampleRejectedStatus, org.omg.dds.core.status.SubscriptionMatchedStatus, and org.opensplice.dds.core.status.AllDataDisposedStatus.

Collaboration diagram for org.omg.dds.core.status.Status:
Collaboration graph

Public Member Functions

ServiceEnvironment getEnvironment ()
 

Static Public Member Functions

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

Detailed Description

Status is the abstract root class for all communication status objects.

All concrete kinds of Status classes extend this class.

Each concrete org.omg.dds.core.Entity is associated with a set of Status objects whose value represents the "communication status" of that entity. These status values can be accessed with corresponding methods on the Entity. The changes on these status values are the ones that both cause activation of the corresponding org.omg.dds.core.StatusCondition objects and trigger invocation of the proper Listener objects to asynchronously inform the application.

See also
org.omg.dds.core.event.StatusChangedEvent

Definition at line 41 of file Status.java.

Member Function Documentation

◆ allStatuses()

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

Definition at line 59 of file Status.java.

◆ 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.

◆ noStatuses()

static Set<Class<? extends Status> > org.omg.dds.core.status.Status.noStatuses ( ServiceEnvironment  env)
static
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: