OpenSplice Java 5 DCPS  v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
org.omg.dds.core.policy.OwnershipStrength Interface Reference

[optional] Specifies the value of the "strength" used to arbitrate among multiple org.omg.dds.pub.DataWriter objects that attempt to modify the same instance of a data object (identified by org.omg.dds.topic.Topic + key). More...

Inheritance diagram for org.omg.dds.core.policy.OwnershipStrength:
Inheritance graph
Collaboration diagram for org.omg.dds.core.policy.OwnershipStrength:
Collaboration graph

Public Member Functions

ServiceEnvironment getEnvironment ()
 
int getValue ()
 
OwnershipStrength withValue (int value)
 Copy this policy and override the value of the property. More...
 

Detailed Description

[optional] Specifies the value of the "strength" used to arbitrate among multiple org.omg.dds.pub.DataWriter objects that attempt to modify the same instance of a data object (identified by org.omg.dds.topic.Topic + key).

This policy only applies if the org.omg.dds.core.policy.Ownership#getKind() is Ownership.Kind#EXCLUSIVE. The default value of the ownership strength is zero.

Concerns: org.omg.dds.pub.DataWriter

RxO: N/A

Changeable: Yes

See also
Ownership

Definition at line 39 of file OwnershipStrength.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.

◆ getValue()

int org.omg.dds.core.policy.OwnershipStrength.getValue ( )
Returns
the value

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

◆ withValue()

OwnershipStrength org.omg.dds.core.policy.OwnershipStrength.withValue ( int  value)

Copy this policy and override the value of the property.

Parameters
valueSpecifies the ownership strength of the DataWriter
Returns
a new OwnershipStrength policy

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


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