org.omg.dds.core.policy

Interface Durability

All Superinterfaces:

Comparable<Durability>, DDSObject, QosPolicy, QosPolicy.ForDataReader, QosPolicy.ForDataWriter, QosPolicy.ForTopic, RequestedOffered<Durability>, Serializable

public interface Durability
extends QosPolicy.ForTopic, QosPolicy.ForDataReader, QosPolicy.ForDataWriter, RequestedOffered<Durability>

This policy expresses if the data should "outlive" their writing time. Concerns: Topic, DataReader, DataWriter RxO: Yes Changeable: No The decoupling between DataReader and DataWriter offered by the Publish/Subscribe paradigm allows an application to write data even if there are no current readers on the network. Moreover, a DataReader that joins the network after some data has been written could potentially be interested in accessing the most current values of the data as well as potentially some history. This QoS policy controls whether the Service will actually make data available to late-joining readers. Note that although related, this does not strictly control what data the Service will maintain internally. That is, the Service may choose to maintain some data for its own purposes (e.g., flow control) and yet not make it available to late-joining readers if the Durability is set to Durability.Kind.VOLATILE. The value offered is considered compatible with the value requested if and only if the inequality offered kind >= requested kind evaluates to true. For the purposes of this inequality, the values of Durability.Kind are considered ordered such that VOLATILE < TRANSIENT_LOCAL < TRANSIENT < PERSISTENT. For the purpose of implementing the Durability.Kind TRANSIENT or PERSISTENT, the service behaves "as if" for each Topic that has TRANSIENT or PERSISTENT DURABILITY kind there was a corresponding "built-in" DataReader and DataWriter configured to have the same DURABILITY kind. In other words, it is "as if" somewhere in the system (possibly on a remote node) there was a "built-in durability DataReader" that subscribed to that Topic and a "built-in durability DataWriter" that published that Topic as needed for the new subscribers that join the system. For each Topic, the built-in fictitious "persistence service" DataReader and DataWriter has its QoS configured from the Topic QoS of the corresponding Topic. In other words, it is "as-if" the service first did DomainParticipant.findTopic(String, org.omg.dds.core.Duration) to access the Topic, and then used the QoS from the Topic to configure the fictitious built-in entities. A consequence of this model is that the transient or persistence service can be configured by means of setting the proper QoS on the Topic. For a given Topic, the usual request/offered semantics apply to the matching between any DataWriter in the system that writes the Topic and the built-in transient/persistent DataReader for that Topic; similarly for the built-in transient/persistent DataWriter for a Topic and any DataReader for the Topic. As a consequence, a DataWriter that has an incompatible QoS with respect to what the Topic specified will not send its data to the transient/persistent service, and a DataReader that has an incompatible QoS with respect to the specified in the Topic will not get data from it. Incompatibilities between local DataReader/DataWriter entities and the corresponding fictitious "built-in transient/persistent entities" cause the RequestedIncompatibleQosStatus/ OfferedIncompatibleQosStatus to change and the corresponding Listener invocations and/or signaling of Condition and WaitSet objects as they would with non-fictitious entities. The setting of the serviceCleanupDelay controls when the TRANSIENT or PERSISTENT service is able to remove all information regarding a data instances. Information on a data instances is maintained until the following conditions are met:

1. the instance has been explicitly disposed (instanceState = InstanceState.NOT_ALIVE_DISPOSED),
2. and while in the NOT_ALIVE_DISPOSED state the system detects that there are no more "alive" DataWriter entities writing the instance, that is, all existing writers either unregister the instance (call DataWriter.unregisterInstance(org.omg.dds.core.InstanceHandle)) or lose their liveliness,
3. and a time interval longer that serviceCleanupDelay has elapsed since the moment the service detected that the previous two conditions were met.

The utility of the serviceCleanupDelay is apparent in the situation where an application disposes an instance and it crashes before it has a chance to complete additional tasks related to the disposition. Upon restart the application may ask for initial data to regain its state and the delay introduced by the serviceCleanupDelay will allow the restarted application to receive the information on the disposed instance and complete the interrupted tasks.

See Also:

DurabilityService, DurabilityService.getServiceCleanupDelay()

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Durability.Kind

Nested classes/interfaces inherited from interface org.omg.dds.core.policy.QosPolicy

QosPolicy.ForDataReader, QosPolicy.ForDataWriter, QosPolicy.ForDomainParticipant, QosPolicy.ForDomainParticipantFactory, QosPolicy.ForPublisher, QosPolicy.ForSubscriber, QosPolicy.ForTopic

Method Summary

Methods

Modifier and Type	Method and Description
Durability.Kind	getKind()
Durability	withKind(Durability.Kind kind) Copy this policy and override the value of the property.
Durability	withPersitent()
Durability	withTransient()
Durability	withTransientLocal()
Durability	withVolatile()

Methods inherited from interface org.omg.dds.core.DDSObject

getEnvironment

Methods inherited from interface org.omg.dds.core.policy.RequestedOffered

requestedOfferedContract

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getKind

Durability.Kind getKind()

Returns:

the kind

withKind

Durability withKind(Durability.Kind kind)

Copy this policy and override the value of the property.

Returns:

a new policy

withVolatile

Durability withVolatile()

Returns:

Volatile durability policy.

withTransientLocal

Durability withTransientLocal()

Returns:

Transient-local durability policy.

withTransient

Durability withTransient()

Returns:

Transient durability policy.

withPersitent

Durability withPersitent()

Returns:

Persistent durability policy.