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

This class contains the statistics about the discovered number of org.omg.dds.pub.DataWriters that are compatible with the org.omg.dds.sub.DataReader to which the Status is attached. More...

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

Public Member Functions

abstract int getCurrentCount ()
 The number of org.omg.dds.pub.DataWriters currently matched to the concerned org.omg.dds.sub.DataReader. More...
 
abstract int getCurrentCountChange ()
 The change in currentCount 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 that matched the org.omg.dds.sub.DataReader, causing the status to change. More...
 
abstract int getTotalCount ()
 Total cumulative count the concerned org.omg.dds.sub.DataReader discovered a "match" with a org.omg.dds.pub.DataWriter. More...
 
abstract int getTotalCountChange ()
 The change in totalCount 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

This class contains the statistics about the discovered number of org.omg.dds.pub.DataWriters that are compatible with the org.omg.dds.sub.DataReader to which the Status is attached.

DataWriter and DataReader are compatible if they use the same org.omg.dds.topic.Topic and if the QoS requested by the DataReader is compatible with that offered by the DataWriter. A DataWriter will automatically connect to a matching DataReader, but will disconnect when that DataWriter is deleted, when either changes its QoS into an incompatible value, or when either puts its matching counterpart on its ignore-list using the ignoreSubscription or ignorePublication operations on the DomainParticipant.

See also
org.omg.dds.core.event.SubscriptionMatchedEvent
PublicationMatchedStatus

Definition at line 36 of file SubscriptionMatchedStatus.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.

◆ getCurrentCount()

abstract int org.omg.dds.core.status.SubscriptionMatchedStatus.getCurrentCount ( )
abstract

The number of org.omg.dds.pub.DataWriters currently matched to the concerned org.omg.dds.sub.DataReader.

◆ getCurrentCountChange()

abstract int org.omg.dds.core.status.SubscriptionMatchedStatus.getCurrentCountChange ( )
abstract

The change in currentCount 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.SubscriptionMatchedStatus.getLastPublicationHandle ( )
abstract

Handle to the last org.omg.dds.pub.DataWriter that matched the org.omg.dds.sub.DataReader, causing the status to change.

◆ getTotalCount()

abstract int org.omg.dds.core.status.SubscriptionMatchedStatus.getTotalCount ( )
abstract

Total cumulative count the concerned org.omg.dds.sub.DataReader discovered a "match" with a org.omg.dds.pub.DataWriter.

That is, it found a DataWriter for the same org.omg.dds.topic.Topic with a requested QoS that is compatible with that offered by the DataReader.

◆ getTotalCountChange()

abstract int org.omg.dds.core.status.SubscriptionMatchedStatus.getTotalCountChange ( )
abstract

The change in totalCount 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: