 |
OpenSplice ISO C++ 2 DCPS
v6.x
ISO C++ 2 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
|
|
OpenSplice ISO C++ 2 DCPS
v6.x
ISO C++ 2 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
|
#include "CorePolicy.hpp"
Public Member Functions | |
| WriterDataLifecycle (bool autodispose_unregistered_instances=true) | |
| WriterDataLifecycle (const WriterDataLifecycle &other) | |
| bool | autodispose_unregistered_instances () const |
| WriterDataLifecycle & | autodispose_unregistered_instances (bool autodispose_unregistered_instances) |
| void | autopurge_suspended_samples_delay (const dds::core::Duration &d) |
| const dds::core::Duration | autopurge_suspended_samples_delay () const |
| void | autounregister_instance_delay (const dds::core::Duration &d) |
| const dds::core::Duration | autounregister_instance_delay () const |
| bool | operator!= (const Value &other) const |
| D * | operator-> () |
| const D * | operator-> () const |
| bool | operator== (const Value &other) const |
Static Public Member Functions | |
| static WriterDataLifecycle | AutoDisposeUnregisteredInstances () |
| static WriterDataLifecycle | ManuallyDisposeUnregisteredInstances () |
This QosPolicy drives the behaviour of a DataWriter concerning the life-cycle of the instances and samples that have been written by it.
| Value | Meaning | Concerns | RxO | Changeable |
|---|---|---|---|---|
| A boolean: autodispose_unregistered_instances | Specifies the behavior of the DataWriter with regards to the lifecycle of the data-instances it manages. Controls whether a DataWriter will automatically dispose instances each time they are unregistered. The setting autodispose_unregistered_instances = TRUE indicates that unregistered instances will also be considered disposed. By default, TRUE. | DataWriter | N/A | Yes |
| A duration: autopurge_suspended_samples_delay | Specifies 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. | |||
| A duration: autounregister_instance_delay | 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 DURATION_INFINITE and therefore no automatic unregistration occurs. |
This QosPolicy controls the behaviour of the DataWriter with regards to the lifecycle of the data-instances it manages; that is, those data-instances that have been registered, either explicitly using one of the register operations, or implicitly by directly writing the data using the special HANDLE_NIL parameter. The autodispose_unregistered_instances flag controls what happens when an instance gets unregistered by the DataWriter:
The default value for the autodispose_unregistered_instances flag is TRUE. For TRANSIENT and PERSISTENT Topics this means that all instances that are not explicitly unregistered by the application will by default be removed from the Transient and Persistent stores when the DataWriter is deleted or when a loss of its liveliness is detected. For DataWriters associated with TRANSIENT and PERSISTENT Topics setting the autodispose_unregister_instances attribute to TRUE would mean that all instances that are not explicitly unregistered by the application will by default be removed from the Transient and Persistent stores when the DataWriter is deleted, when a loss of liveliness is detected, or when the autounregister_instance_delay expires.
Definition at line 678 of file CorePolicy.hpp.
|
explicit |
Creates a WriterDataLifecycle QoS instance
| autodispose_unregistered_instances | Specifies the behavior of the DataWriter with regards to the lifecycle of the data-instances it manages. |
Definition at line 519 of file CorePolicyImpl.hpp.
| dds::core::policy::WriterDataLifecycle::WriterDataLifecycle | ( | const WriterDataLifecycle & | other | ) |
Copies a WriterDataLifecycle QoS instance
| other | the WriterDataLifecycle QoS instance to copy |
Definition at line 522 of file CorePolicyImpl.hpp.
| bool dds::core::policy::WriterDataLifecycle::autodispose_unregistered_instances | ( | ) | const |
Gets a boolean indicating if unregistered instances should be autodisposed
Definition at line 525 of file CorePolicyImpl.hpp.
| WriterDataLifecycle & dds::core::policy::WriterDataLifecycle::autodispose_unregistered_instances | ( | bool | autodispose_unregistered_instances | ) |
Sets a boolean indicating if unregistered instances should be autodisposed
| autodispose_unregistered_instances | a boolean indicating if unregistered instances should be autodisposed |
Definition at line 531 of file CorePolicyImpl.hpp.
|
static |
Definition at line 538 of file CorePolicyImpl.hpp.
| void dds::core::policy::WriterDataLifecycle::autopurge_suspended_samples_delay | ( | const dds::core::Duration & | d | ) |
Sets the autopurge_suspended_samples_delay
Call
This is a proprietary operation and can be called by using the operator->.
| d | Specifies 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. See dds::pub::SuspendedPublication for more information about suspended publication. |
| const dds::core::Duration dds::core::policy::WriterDataLifecycle::autopurge_suspended_samples_delay | ( | ) | const |
Gets the autopurge_suspended_samples_delay
Call
This is a proprietary operation and can be called by using the operator->.
| void dds::core::policy::WriterDataLifecycle::autounregister_instance_delay | ( | const dds::core::Duration & | d | ) |
Sets the autounregister_instance_delay
Call
This is a proprietary operation and can be called by using the operator->.
| d | 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 DURATION_INFINITE and therefore no automatic unregistration occurs. |
| const dds::core::Duration dds::core::policy::WriterDataLifecycle::autounregister_instance_delay | ( | ) | const |
Gets the autounregister_instance_delay
Call
This is a proprietary operation and can be called by using the operator->.
|
static |
Definition at line 544 of file CorePolicyImpl.hpp.
|
inherited |
|
inherited |
The operator->() is provided to be able to directly invoke functions on the delegate.
The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:
|
inherited |
The operator->() is provided to be able to directly invoke functions on the delegate.
The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:
|
inherited |
1.8.13