DDS_WriterDataLifecycleQosPolicy Struct Reference

Controls how a DDS_DataWriter handles the lifecycle of the instances (keys) that it is registered to manage. More...

Data Fields
DDS_Boolean	autodispose_unregistered_instances
	Boolean flag that controls the behavior when the DDS_DataWriter unregisters an instance by means of the unregister operations.
struct DDS_Duration_t	autopurge_unregistered_instances_delay
	<<eXtension>> Maximum duration for which the DDS_DataWriter will maintain information regarding an instance once it has unregistered the instance.

Detailed Description

Controls how a DDS_DataWriter handles the lifecycle of the instances (keys) that it is registered to manage.

Entity:

DDS_DataWriter

Properties:

RxO = N/A
Changeable = YES

Usage

This policy determines how the DDS_DataWriter acts with regards to the lifecycle of the data instances it manages (data instances that have been either explicitly registered with the DDS_DataWriter or implicitly registered by directly writing the data).

Since the deletion of a DataWriter automatically unregisters all data instances it manages, the setting of the autodispose_unregistered_instances flag will only determine whether instances are ultimately disposed when the DDS_DataWriter is deleted either directly by means of the DDS_Publisher_delete_datawriter operation or indirectly as a consequence of calling DDS_Publisher_delete_contained_entities or DDS_DomainParticipant_delete_contained_entities that contains the DataWriter.

You may use FooDataWriter_unregister_instance to indicate that the DDS_DataWriter no longer wants to send data for a DDS_Topic.

The behavior controlled by this QoS policy applies on a per instance (key) basis for keyed Topics, so that when a DDS_DataWriter unregisters an instance, RTI Connext can automatically also dispose that instance. This is the default behavior.

In many cases where the ownership of a Topic is shared (see DDS_OwnershipQosPolicy), DataWriters may want to relinquish their ownership of a particular instance of the Topic to allow other DataWriters to send updates for the value of that instance regardless of Ownership Strength. In that case, you may only want a DataWriter to unregister an instance without disposing the instance. Disposing an instance is a statement that an instance no longer exists. User applications may be coded to trigger on the disposal of instances, thus the ability to unregister without disposing may be useful to properly maintain the semantic of disposal.

Field Documentation

DDS_Boolean DDS_WriterDataLifecycleQosPolicy::autodispose_unregistered_instances

Boolean flag that controls the behavior when the DDS_DataWriter unregisters an instance by means of the unregister operations.

• DDS_BOOLEAN_TRUE (default)
  The DDS_DataWriter will dispose the instance each time it is unregistered. The behavior is identical to explicitly calling one of the dispose operations on the instance prior to calling the unregister operation.

• DDS_BOOLEAN_FALSE
  

  The DDS_DataWriter will not dispose the instance. The application can still call one of the dispose operations prior to unregistering the instance and accomplish the same effect.

[default] DDS_BOOLEAN_TRUE

struct DDS_Duration_t DDS_WriterDataLifecycleQosPolicy::autopurge_unregistered_instances_delay

<<eXtension>> Maximum duration for which the DDS_DataWriter will maintain information regarding an instance once it has unregistered the instance.

After this time elapses, the DDS_DataWriter will purge all internal information regarding the instance, including historical samples.

When the duration is zero, the instance is purged as soon as all the samples have been acknowledged by all the live DataReaders.

[default] DDS_DURATION_INFINITE (disabled)

[range] [0, 1 year] or DDS_DURATION_INFINITE