org.omg.dds.core.policy.DestinationOrder Interface Reference

Controls the criteria used to determine the logical order among changes made by org.omg.dds.pub.Publisher entities to the same instance of data (i.e., matching Topic and key). More...

Inheritance diagram for org.omg.dds.core.policy.DestinationOrder:

Collaboration diagram for org.omg.dds.core.policy.DestinationOrder:

Classes
enum	Kind

Public Member Functions
ServiceEnvironment	getEnvironment ()
Kind	getKind ()
Comparable< SELF >	requestedOfferedContract ()
	Use the object returned by this method to evaluate the Request/Offer relationship with another instance of this policy. More...
DestinationOrder	withKind (Kind kind)
	Copy this policy and override the value of the property. More...
DestinationOrder	withReceptionTimestamp ()
DestinationOrder	withSourceTimestamp ()

Detailed Description

Controls the criteria used to determine the logical order among changes made by org.omg.dds.pub.Publisher entities to the same instance of data (i.e., matching Topic and key).

The default kind is DestinationOrder.Kind#BY_RECEPTION_TIMESTAMP.

Concerns: org.omg.dds.topic.Topic, org.omg.dds.sub.DataReader, org.omg.dds.pub.DataWriter

RxO: Yes

Changeable: No

This policy controls how each subscriber resolves the final value of a data instance that is written by multiple DataWriter objects (which may be associated with different Publisher objects) running on different nodes.

The setting Kind#BY_RECEPTION_TIMESTAMP indicates that, assuming the org.omg.dds.core.policy.Ownership allows it, the latest received value for the instance should be the one whose value is kept. This is the default value.

The setting Kind#BY_SOURCE_TIMESTAMP indicates that, assuming the org.omg.dds.core.policy.Ownership allows it, a time stamp placed at the source should be used. This is the only setting that, in the case of concurrent same-strength DataWriter objects updating the same instance, ensures all subscribers will end up with the same final value for the instance. This means that the system needs some time synchronization.

The value offered is considered compatible with the value requested if and only if the inequality "offered kind &gt;= requested kind" evaluates to true. For the purposes of this inequality, the values of DESTINATION_ORDER kind are considered ordered such that BY_RECEPTION_TIMESTAMP < BY_SOURCE_TIMESTAMP.

See also

Ownership

Definition at line 58 of file DestinationOrder.java.

Member Function Documentation

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.

getKind()

Kind org.omg.dds.core.policy.DestinationOrder.getKind

(

)

Returns

the kind

Implemented in org.opensplice.dds.core.policy.DestinationOrderImpl.

requestedOfferedContract()

Comparable<SELF> org.omg.dds.core.policy.RequestedOffered< SELF >.requestedOfferedContract ( )

inherited

Use the object returned by this method to evaluate the Request/Offer relationship with another instance of this policy.

If this policy is offered by a org.omg.dds.pub.DataWriter (or org.omg.dds.pub.Publisher), any other policy evaluated as less than or equal to it by the Comparable may be compatibly requested by a org.omg.dds.sub.DataReader (or org.omg.dds.sub.Subscriber). Similarly, if this policy is requested, any other policy that is greater than or equal to it may be compatibly offered.

Returns

a Comparable object capable of evaluating the Request/Offer relationship between two instances of the QoS policy identified by the type parameter SELF.

withKind()

DestinationOrder org.omg.dds.core.policy.DestinationOrder.withKind

(

Kind

kind

)

Copy this policy and override the value of the property.

Parameters

kind	Specifies the order in which the DataReader stores the data. This can be BY_RECEPTION_TIMESTAMP or BY_SOURCE_TIMESTAMP.

Returns

a new DestinationOrder policy

Implemented in org.opensplice.dds.core.policy.DestinationOrderImpl.

withReceptionTimestamp()

DestinationOrder org.omg.dds.core.policy.DestinationOrder.withReceptionTimestamp

(

)

Returns

A new DestinationPolicy with reception timestamp ordering.

Implemented in org.opensplice.dds.core.policy.DestinationOrderImpl.

withSourceTimestamp()

DestinationOrder org.omg.dds.core.policy.DestinationOrder.withSourceTimestamp

(

)

Returns

A new DestinationPolicy with source timestamp ordering.

Implemented in org.opensplice.dds.core.policy.DestinationOrderImpl.

---

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

• java5/common/java/code/org/omg/dds/core/policy/DestinationOrder.java