org.opensplice.dds.core.policy.Reliability Interface Reference

OpenSplice-specific extension to org.omg.dds.core.policy.Reliability That specifies whether a DataWriter should wait for acknowledgements by all connected DataReaders that also have set a synchronous ReliabilityQosPolicy. More...

Inheritance diagram for org.opensplice.dds.core.policy.Reliability:

Collaboration diagram for org.opensplice.dds.core.policy.Reliability:

Public Member Functions
ServiceEnvironment	getEnvironment ()
Kind	getKind ()
Duration	getMaxBlockingTime ()
boolean	isSynchronous ()
Comparable< SELF >	requestedOfferedContract ()
	Use the object returned by this method to evaluate the Request/Offer relationship with another instance of this policy. More...
Reliability	withBestEffort ()
Reliability	withKind (Kind kind)
	Copy this policy and override the value of the property. More...
Reliability	withMaxBlockingTime (Duration maxBlockingTime)
	Copy this policy and override the value of the property. More...
Reliability	withMaxBlockingTime (long maxBlockingTime, TimeUnit unit)
	Copy this policy and override the value of the property. More...
Reliability	withReliable ()
Reliability	withSynchronous (boolean synchronous)
	Copy this policy and override the value of the property. More...

Detailed Description

OpenSplice-specific extension to org.omg.dds.core.policy.Reliability That specifies whether a DataWriter should wait for acknowledgements by all connected DataReaders that also have set a synchronous ReliabilityQosPolicy.

It is advised only to use this policy in combination with reliability, if used in combination with best effort data may not arrive at the DataReader resulting in a timeout at the DataWriter indicating that the data has not been received. Acknoledgments are always sent reliable so when the DataWriter encounters a timeout it is guaranteed that the DataReader hasn't received the data.

Definition at line 31 of file Reliability.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.Reliability.getKind ( )

inherited

Returns

the kind

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

getMaxBlockingTime()

Duration org.omg.dds.core.policy.Reliability.getMaxBlockingTime ( )

inherited

Returns

the maximum blocking time

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

isSynchronous()

boolean org.opensplice.dds.core.policy.Reliability.isSynchronous

(

)

Returns

true if synchronous property is set, false otherwise.

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.

withBestEffort()

Reliability org.omg.dds.core.policy.Reliability.withBestEffort ( )

inherited

Returns

a best effort Reliability policy

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

withKind()

Reliability org.omg.dds.core.policy.Reliability.withKind ( Kind  kind )

inherited

Copy this policy and override the value of the property.

Parameters

kind	Specifies the type of reliability which may be BEST_EFFORT or RELIABLE.

Returns

a new Reliability policy

withMaxBlockingTime() [1/2]

Reliability org.omg.dds.core.policy.Reliability.withMaxBlockingTime ( Duration  maxBlockingTime )

inherited

Copy this policy and override the value of the property.

Parameters

maxBlockingTime

Specifies a duration which is the maximum time the write operation may block when the DataWriter does not have space to store the value or when synchronous communication is specified and all expected acknowledgments are not yet received.

Returns

a new Reliability policy

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

withMaxBlockingTime() [2/2]

Reliability org.omg.dds.core.policy.Reliability.withMaxBlockingTime ( long  maxBlockingTime, TimeUnit  unit  )

inherited

Copy this policy and override the value of the property.

Parameters

maxBlockingTime	Specifies a long maxBlockingTime which is the maximum time the write operation may block when the DataWriter does not have space to store the value or when synchronous communication is specified and all expected acknowledgments are not yet received.
unit	The TimeUnit which the period describes (i.e. TimeUnit.SECONDS or TimeUnit.MILLISECONDS)

Returns

a new Reliability policy

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

withReliable()

Reliability org.omg.dds.core.policy.Reliability.withReliable ( )

inherited

Returns

a reliable Reliability policy

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

withSynchronous()

Reliability org.opensplice.dds.core.policy.Reliability.withSynchronous

(

boolean

synchronous

)

Copy this policy and override the value of the property.

Parameters

synchronous

Specifies whether a DataWriter should wait for acknowledgements by all connected DataReaders that also have set a synchronous ReliabilityQosPolicy.

Returns

a new Reliability policy

---

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

• java5/common/java/code/org/opensplice/dds/core/policy/Reliability.java