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

This class provides OpenSplice-specific extensions to the org.omg.dds.core.policy.ReaderDataLifecycle policy. More...

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

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

Classes
enum	Kind
	Instance state changes are communicated to a org.omg.dds.sub.DataReader by means of the sample info accompanying a org.omg.dds.sub.Sample. More...

Public Member Functions
boolean	getAutoPurgeDisposeAll ()
	Whether or not instances that have been disposed by means of the org.opensplice.dds.topic.Topic#disposeAllData() method will automatically be purged by the middleware or not. More...
Duration	getAutoPurgeDisposedSamplesDelay ()
Duration	getAutoPurgeNoWriterSamplesDelay ()
ServiceEnvironment	getEnvironment ()
Kind	getInvalidSampleInvisibility ()
	Provides access to the ReaderDataLifecycle.Kind that drives invalid sample visibility. More...
ReaderDataLifecycle	withAutoPurgeDisposeAll ()
	Creates a copy of this ReaderDataLifecycle that has its autoPurgeDisposeAll set to true. More...
ReaderDataLifecycle	withAutoPurgeDisposedSamplesDelay (Duration autoPurgeDisposedSamplesDelay)
	Copy this policy and override the value of the property. More...
ReaderDataLifecycle	withAutoPurgeDisposedSamplesDelay (long autoPurgeDisposedSamplesDelay, TimeUnit unit)
	Copy this policy and override the value of the property. More...
ReaderDataLifecycle	withAutoPurgeNoWriterSamplesDelay (Duration autoPurgeNoWriterSamplesDelay)
	Copy this policy and override the value of the property. More...
ReaderDataLifecycle	withAutoPurgeNoWriterSamplesDelay (long autoPurgeNoWriterSamplesDelay, TimeUnit unit)
	Copy this policy and override the value of the property. More...
ReaderDataLifecycle	withInvalidSampleInvisibility (Kind kind)
	Creates a copy of this ReaderDataLifecycle that has its invalid sample visibility set to the supplied value. More...

Detailed Description

This class provides OpenSplice-specific extensions to the org.omg.dds.core.policy.ReaderDataLifecycle policy.

Definition at line 28 of file ReaderDataLifecycle.java.

Member Function Documentation

getAutoPurgeDisposeAll()

boolean org.opensplice.dds.core.policy.ReaderDataLifecycle.getAutoPurgeDisposeAll

(

)

Whether or not instances that have been disposed by means of the org.opensplice.dds.topic.Topic#disposeAllData() method will automatically be purged by the middleware or not.

Returns

true if instances are automatically purged, false otherwise.

getAutoPurgeDisposedSamplesDelay()

Duration org.omg.dds.core.policy.ReaderDataLifecycle.getAutoPurgeDisposedSamplesDelay ( )

inherited

Returns

the duration of the autoPurgeDisposedSamplesDelay

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

getAutoPurgeNoWriterSamplesDelay()

Duration org.omg.dds.core.policy.ReaderDataLifecycle.getAutoPurgeNoWriterSamplesDelay ( )

inherited

Returns

the duration of the autoPurgeNoWriterSamplesDelay

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

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.

getInvalidSampleInvisibility()

Kind org.opensplice.dds.core.policy.ReaderDataLifecycle.getInvalidSampleInvisibility

(

)

Provides access to the ReaderDataLifecycle.Kind that drives invalid sample visibility.

Returns

The invalid sample visibility.

withAutoPurgeDisposeAll()

ReaderDataLifecycle org.opensplice.dds.core.policy.ReaderDataLifecycle.withAutoPurgeDisposeAll

(

)

Creates a copy of this ReaderDataLifecycle that has its autoPurgeDisposeAll set to true.

Returns

a copy of this policy with autoPurgeDisposeAll set to true.

withAutoPurgeDisposedSamplesDelay() [1/2]

ReaderDataLifecycle org.omg.dds.core.policy.ReaderDataLifecycle.withAutoPurgeDisposedSamplesDelay ( Duration  autoPurgeDisposedSamplesDelay )

inherited

Copy this policy and override the value of the property.

Parameters

autoPurgeDisposedSamplesDelay

Specifies a duration autoPurgeDisposedSamplesDelay for which the DataReader will maintain information regarding a data instance for which the instance_state becomes NOT_ALIVE_DISPOSED. By default the duration value is DURATION_INFINITE. When the delay time has expired, the data instance is marked so that it can be purged in the next garbage collection sweep.

Returns

a new ReaderDataLifecycle policy

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

withAutoPurgeDisposedSamplesDelay() [2/2]

ReaderDataLifecycle org.omg.dds.core.policy.ReaderDataLifecycle.withAutoPurgeDisposedSamplesDelay ( long  autoPurgeDisposedSamplesDelay, TimeUnit  unit  )

inherited

Copy this policy and override the value of the property.

Parameters

autoPurgeDisposedSamplesDelay	Specifies a long autoPurgeDisposedSamplesDelay for which the DataReader will maintain information regarding a data instance for which the instance_state becomes NOT_ALIVE_DISPOSED. By default the duration value is DURATION_INFINITE. When the delay time has expired, the data instance is marked so that it can be purged in the next garbage collection sweep.
unit	The TimeUnit which the period describes (i.e. TimeUnit.SECONDS or TimeUnit.MILLISECONDS)

Returns

a new policy

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

withAutoPurgeNoWriterSamplesDelay() [1/2]

ReaderDataLifecycle org.omg.dds.core.policy.ReaderDataLifecycle.withAutoPurgeNoWriterSamplesDelay ( Duration  autoPurgeNoWriterSamplesDelay )

inherited

Copy this policy and override the value of the property.

Parameters

autoPurgeNoWriterSamplesDelay

Specifies the duration for which the DataReader will maintain information regarding a data instance for which the instance_state becomes NOT_ALIVE_NO_WRITERS. By default the duration value is DURATION_INFINITE. When the delay time has expired, the data instance is marked so that it can be purged in the next garbage collection sweep.

Returns

a new ReaderDataLifecycle policy

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

withAutoPurgeNoWriterSamplesDelay() [2/2]

ReaderDataLifecycle org.omg.dds.core.policy.ReaderDataLifecycle.withAutoPurgeNoWriterSamplesDelay ( long  autoPurgeNoWriterSamplesDelay, TimeUnit  unit  )

inherited

Copy this policy and override the value of the property.

Parameters

autoPurgeNoWriterSamplesDelay	Specifies a long autoPurgeNoWriterSamplesDelay for which the DataReader will maintain information regarding a data instance for which the instance_state becomes NOT_ALIVE_NO_WRITERS. By default the duration value is DURATION_INFINITE. When the delay time has expired, the data instance is marked so that it can be purged in the next garbage collection sweep.
unit	The TimeUnit which the period describes (i.e. TimeUnit.SECONDS or TimeUnit.MILLISECONDS)

Returns

a new ReaderDataLifecycle policy

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

withInvalidSampleInvisibility()

ReaderDataLifecycle org.opensplice.dds.core.policy.ReaderDataLifecycle.withInvalidSampleInvisibility

(

Kind

kind

)

Creates a copy of this ReaderDataLifecycle that has its invalid sample visibility set to the supplied value.

Parameters

kind	the invalid sample visibility kind to set.

Returns

a copy of this policy with supplied invalid sample visibility set to true.

---

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

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