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

Specifies the configuration of the durability service. More...

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

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

Public Member Functions
ServiceEnvironment	getEnvironment ()
int	getHistoryDepth ()
History.Kind	getHistoryKind ()
int	getMaxInstances ()
int	getMaxSamples ()
int	getMaxSamplesPerInstance ()
Duration	getServiceCleanupDelay ()
DurabilityService	withHistoryDepth (int historyDepth)
	Copy this policy and override the value of the property. More...
DurabilityService	withHistoryKind (History.Kind historyKind)
	Copy this policy and override the value of the property. More...
DurabilityService	withMaxInstances (int maxInstances)
	Copy this policy and override the value of the property. More...
DurabilityService	withMaxSamples (int maxSamples)
	Copy this policy and override the value of the property. More...
DurabilityService	withMaxSamplesPerInstance (int maxSamplesPerInstance)
	Copy this policy and override the value of the property. More...
DurabilityService	withServiceCleanupDelay (Duration serviceCleanupDelay)
	Copy this policy and override the value of the property. More...
DurabilityService	withServiceCleanupDelay (long serviceCleanupDelay, TimeUnit unit)
	Copy this policy and override the value of the property. More...

Detailed Description

Specifies the configuration of the durability service.

That is, the service that implements the Durability.Kind of Durability.Kind#TRANSIENT and Durability.Kind#PERSISTENT.

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

RxO: No

Changeable: No

This policy is used to configure the org.omg.dds.core.policy.History and the org.omg.dds.core.policy.ResourceLimits used by the fictitious org.omg.dds.sub.DataReader and org.omg.dds.pub.DataWriter used by the "persistence service." The "persistence service" is the one responsible for implementing Durability.Kind#TRANSIENT and Durability.Kind#PERSISTENT.

See also

Durability

Definition at line 49 of file DurabilityService.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.

getHistoryDepth()

int org.omg.dds.core.policy.DurabilityService.getHistoryDepth

(

)

Returns

the historyDepth

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

getHistoryKind()

History.Kind org.omg.dds.core.policy.DurabilityService.getHistoryKind

(

)

Returns

the historyKind

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

getMaxInstances()

int org.omg.dds.core.policy.DurabilityService.getMaxInstances

(

)

Returns

the maxInstances

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

getMaxSamples()

int org.omg.dds.core.policy.DurabilityService.getMaxSamples

(

)

Returns

the maxSamples

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

getMaxSamplesPerInstance()

int org.omg.dds.core.policy.DurabilityService.getMaxSamplesPerInstance

(

)

Returns

the maxSamplesPerInstance

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

getServiceCleanupDelay()

Duration org.omg.dds.core.policy.DurabilityService.getServiceCleanupDelay

(

)

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

withHistoryDepth()

DurabilityService org.omg.dds.core.policy.DurabilityService.withHistoryDepth

(

int

historyDepth

)

Copy this policy and override the value of the property.

Parameters

historyDepth

Specifies the number of samples of each instance of data (identified by its key) that is managed by the durability service for the transient or persistent topic data-instances. If history_kind is KEEP_LAST, history_depth must be smaller than or equal to max_samples_per_instance for this QosPolicy to be consistent.

Returns

a new DurabilityService policy

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

withHistoryKind()

DurabilityService org.omg.dds.core.policy.DurabilityService.withHistoryKind

(

History.Kind

historyKind

)

Copy this policy and override the value of the property.

Parameters

historyKind

Specifies the type of history, which may be KEEP_LAST or KEEP_ALL, the durability service must apply for the transient or persistent topic data-instances.

Returns

a new DurabilityService policy

withMaxInstances()

DurabilityService org.omg.dds.core.policy.DurabilityService.withMaxInstances

(

int

maxInstances

)

Copy this policy and override the value of the property.

Parameters

maxInstances

Specifies the maximum number of instances the durability service - manage for the transient or persistent topic data-instances.

Returns

a new DurabilityService policy

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

withMaxSamples()

DurabilityService org.omg.dds.core.policy.DurabilityService.withMaxSamples

(

int

maxSamples

)

Copy this policy and override the value of the property.

Parameters

maxSamples

Specifies the maximum number of data samples for all instances the durability service will manage for the transient or persistent topic data-instances.

Returns

a new DurabilityService policy

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

withMaxSamplesPerInstance()

DurabilityService org.omg.dds.core.policy.DurabilityService.withMaxSamplesPerInstance

(

int

maxSamplesPerInstance

)

Copy this policy and override the value of the property.

Parameters

maxSamplesPerInstance

Specifies the maximum number of samples of any single instance the durability service will manage for the transient or persistent topic data-instances. If history_kind is KEEP_LAST, max_samples_per_instance must be greater than or equal to history_depth for this QosPolicy to be consistent.

Returns

a new DurabilityService policy

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

withServiceCleanupDelay() [1/2]

DurabilityService org.omg.dds.core.policy.DurabilityService.withServiceCleanupDelay

(

Duration

serviceCleanupDelay

)

Copy this policy and override the value of the property.

Parameters

serviceCleanupDelay

A duration on how long the durability service must wait before it is allowed to remove the information on the transient or persistent topic data-instances as a result of incoming dispose messages.

Returns

a new DurabilityService policy

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

withServiceCleanupDelay() [2/2]

DurabilityService org.omg.dds.core.policy.DurabilityService.withServiceCleanupDelay	(	long	serviceCleanupDelay,
		TimeUnit	unit
	)

Copy this policy and override the value of the property.

Parameters

serviceCleanupDelay	A long on how long the durability service must wait before it is allowed to remove the information on the transient or persistent topic data-instances as a result of incoming dispose messages.
unit	The TimeUnit which the serviceCleanupDelay long describes (i.e. TimeUnit.SECONDS or TimeUnit.MILLISECONDS)

Returns

a new DurabilityService policy

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

---

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

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