OpenSplice Java 5 DCPS  v6.x
OpenSplice Java 5 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
Public Member Functions | List of all members
org.opensplice.dds.core.policy.WriterDataLifecycle Interface Reference

This QosPolicy provides OpenSplice-specific extensions to the org.omg.dds.core.policy.WriterDataLifecycle. More...

Inheritance diagram for org.opensplice.dds.core.policy.WriterDataLifecycle:
Inheritance graph
Collaboration diagram for org.opensplice.dds.core.policy.WriterDataLifecycle:
Collaboration graph

Public Member Functions

Duration getAutoPurgeSuspendedSamplesDelay ()
 
Duration getAutoUnregisterInstanceDelay ()
 
ServiceEnvironment getEnvironment ()
 
boolean isAutDisposeUnregisteredInstances ()
 
WriterDataLifecycle withAutDisposeUnregisteredInstances (boolean autDisposeUnregisteredInstances)
 Copy this policy and override the value of the property. More...
 
WriterDataLifecycle withAutoPurgeSuspendedSamplesDelay (Duration duration)
 Copy this policy and override the value of the property. More...
 
WriterDataLifecycle withAutoPurgeSuspendedSamplesDelay (long duration, TimeUnit unit)
 Copy this policy and override the value of the property. More...
 
WriterDataLifecycle withAutoUnregisterInstanceDelay (Duration duration)
 Copy this policy and override the value of the property. More...
 
WriterDataLifecycle withAutoUnregisterInstanceDelay (long duration, TimeUnit unit)
 Copy this policy and override the value of the property. More...
 

Detailed Description

This QosPolicy provides OpenSplice-specific extensions to the org.omg.dds.core.policy.WriterDataLifecycle.

Next to all attributes in the original QosPolicy, it also provides:

  • autoPurgeSuspendedSamplesDelay - specifies the duration after which the org.omg.dds.pub.DataWriter will automatically remove a sample from its history during periods in which its Publisher is suspended. This duration is calculated based on the source timestamp of the written sample. By default the duration value is set to infinite and therefore no automatic purging of samples occurs. See org.omg.dds.pub.Publisher#suspendPublications() for more information on suspended publications
  • autoUnregisterInstanceDelay - specifies the Duration after which the DataWriter will automatically unregister an instance after the application wrote a sample for it and no further action is performed on the same instance by this DataWriter afterwards. This means that when the application writes a new sample for this instance, the duration is recalculated from that action onwards. By default the duration value is infinite and therefore no automatic unregistration occurs.

Definition at line 50 of file WriterDataLifecycle.java.

Member Function Documentation

◆ getAutoPurgeSuspendedSamplesDelay()

Duration org.opensplice.dds.core.policy.WriterDataLifecycle.getAutoPurgeSuspendedSamplesDelay ( )
Returns
the autoPurgeSuspendedSamplesDelay Duration

◆ getAutoUnregisterInstanceDelay()

Duration org.opensplice.dds.core.policy.WriterDataLifecycle.getAutoUnregisterInstanceDelay ( )
Returns
the autoUnregisterInstanceDelay Duration

◆ 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.

◆ isAutDisposeUnregisteredInstances()

boolean org.omg.dds.core.policy.WriterDataLifecycle.isAutDisposeUnregisteredInstances ( )
inherited
Returns
the autDisposeUnregisteredInstances

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

◆ withAutDisposeUnregisteredInstances()

WriterDataLifecycle org.omg.dds.core.policy.WriterDataLifecycle.withAutDisposeUnregisteredInstances ( boolean  autDisposeUnregisteredInstances)
inherited

Copy this policy and override the value of the property.

Parameters
autDisposeUnregisteredInstancesSpecifies whether the Data Distribution Service should automatically dispose instances that are unregistered by this DataWriter. By default this value is true.
Returns
a new WriterDataLifecycle policy

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

◆ withAutoPurgeSuspendedSamplesDelay() [1/2]

WriterDataLifecycle org.opensplice.dds.core.policy.WriterDataLifecycle.withAutoPurgeSuspendedSamplesDelay ( Duration  duration)

Copy this policy and override the value of the property.

Parameters
durationSpecifies the duration after which the DataWriter will automatically remove a sample from its history during periods in which its Publisher is suspended. This duration is calculated based on the source timestamp of the written sample. By default the duration value is set to DURATION_INFINITE and therefore no automatic purging of samples occurs.
Returns
a new WriterDataLifecycle policy

◆ withAutoPurgeSuspendedSamplesDelay() [2/2]

WriterDataLifecycle org.opensplice.dds.core.policy.WriterDataLifecycle.withAutoPurgeSuspendedSamplesDelay ( long  duration,
TimeUnit  unit 
)

Copy this policy and override the value of the property.

Parameters
durationSpecifies the duration after which the DataWriter will automatically remove a sample from its history during periods in which its Publisher is suspended. This duration is calculated based on the source timestamp of the written sample. By default the duration value is set to DURATION_INFINITE and therefore no automatic purging of samples occurs.
unitThe TimeUnit which the period describes (i.e. TimeUnit.SECONDS or TimeUnit.MILLISECONDS)
Returns
a new policy

◆ withAutoUnregisterInstanceDelay() [1/2]

WriterDataLifecycle org.opensplice.dds.core.policy.WriterDataLifecycle.withAutoUnregisterInstanceDelay ( Duration  duration)

Copy this policy and override the value of the property.

Parameters
durationSpecifies the duration after which the DataWriter will automatically unregister an instance after the application wrote a sample for it and no further action is performed on the same instance by this DataWriter afterwards. This means that when the application writes a new sample for this instance, the duration is recalculated from that action onwards. By default the duration value is DURATION_INFINITE and therefore no automatic unregistration occurs.
Returns
a new WriterDataLifecycle policy

◆ withAutoUnregisterInstanceDelay() [2/2]

WriterDataLifecycle org.opensplice.dds.core.policy.WriterDataLifecycle.withAutoUnregisterInstanceDelay ( long  duration,
TimeUnit  unit 
)

Copy this policy and override the value of the property.

Parameters
durationSpecifies the duration after which the DataWriter will automatically unregister an instance after the application wrote a sample for it and no further action is performed on the same instance by this DataWriter afterwards. This means that when the application writes a new sample for this instance, the duration is recalculated from that action onwards. By default the duration value is DURATION_INFINITE and therefore no automatic unregistration occurs.
unitThe TimeUnit which the period describes (i.e. TimeUnit.SECONDS or TimeUnit.MILLISECONDS)
Returns
a new WriterDataLifecycle policy
The documentation for this interface was generated from the following file: