dds::core::policy::DurabilityService Class Reference

Configures the external RTI Persistence Service used by persistent and transient DataWriters. More...

#include <dds/core/policy/CorePolicy.hpp>

Public Member Functions
	DurabilityService ()
	Creates the default policy.
	DurabilityService (const dds::core::Duration &the_service_cleanup_delay, dds::core::policy::HistoryKind the_history_kind, int32_t the_history_depth, int32_t the_max_samples, int32_t the_max_instances, int32_t the_max_samples_per_instance)
	Creates an instance with all the parameters set.
DurabilityService &	service_cleanup_delay (const dds::core::Duration &d)
	Controls when the service is able to remove all information regarding a data instances.
dds::core::Duration	service_cleanup_delay () const
	Getter (see setter with the same name)
DurabilityService &	history_kind (dds::core::policy::HistoryKind the_kind)
	Controls when the service is able to remove all information regarding a data instances.
dds::core::policy::HistoryKind	history_kind () const
	Getter (see setter with the same name)
DurabilityService &	history_depth (int32_t the_depth)
	Controls when the service is able to remove all information regarding a data instances.
int32_t	history_depth () const
	Getter (see setter with the same name)
DurabilityService &	max_samples (int32_t the_max_samples)
	Controls when the service is able to remove all information regarding a data instances.
int32_t	max_samples () const
	Getter (see setter with the same name)
DurabilityService &	max_instances (int32_t the_max_instances)
	Controls when the service is able to remove all information regarding a data instances.
DurabilityService &	max_samples_per_instance (int32_t the_max_samples_per_instance)
	Controls when the service is able to remove all information regarding a data instances.
int32_t	max_samples_per_instance () const
	Getter (see setter with the same name)

Detailed Description

Configures the external RTI Persistence Service used by persistent and transient DataWriters.

Entity:

dds::topic::Topic, dds::pub::DataWriter

Properties:

RxO = NO
Changeable = UNTIL ENABLE

See Also

DURABILITY

HISTORY

RESOURCE_LIMITS

Usage

When a DataWriter's dds::core::policy::Durability::kind is dds::core::policy::DurabilityKind::PERSISTENT or dds::core::policy::DurabilityKind::TRANSIENT, an external service, the RTI Persistence Service, is used to store and possibly forward the data sent by the dds::pub::DataWriter to dds::sub::DataReader objects that are created after the data was initially sent.

This QoS policy is used to configure certain parameters of the Persistence Service when it operates on the behalf of the dds::pub::DataWriter, such as how much data to store. For example, it configures the HISTORY and the RESOURCE_LIMITS used by the fictitious DataReader and DataWriter used by the Persistence Service. Note, however, that the Persistence Service itself may be configured to ignore these values and instead use values from its own configuration file.

Constructor & Destructor Documentation

dds::core::policy::DurabilityService::DurabilityService ( )

inline

Creates the default policy.

dds::core::policy::DurabilityService::DurabilityService ( const dds::core::Duration &  the_service_cleanup_delay, dds::core::policy::HistoryKind  the_history_kind, int32_t  the_history_depth, int32_t  the_max_samples, int32_t  the_max_instances, int32_t  the_max_samples_per_instance  )

inline

Creates an instance with all the parameters set.

Member Function Documentation

DurabilityService& dds::core::policy::DurabilityService::service_cleanup_delay ( const dds::core::Duration &  d )

inline

Controls when the service is able to remove all information regarding a data instances.

When the service cleanup delay is set to 0, disposed instances will be completely removed from the service. Only values of 0 and dds::core::Duration::infinite() are currently supported.

[default] 0

dds::core::Duration dds::core::policy::DurabilityService::service_cleanup_delay ( ) const

inline

Getter (see setter with the same name)

DurabilityService& dds::core::policy::DurabilityService::history_kind ( dds::core::policy::HistoryKind  the_kind )

inline

Controls when the service is able to remove all information regarding a data instances.

When the service cleanup delay is set to 0, disposed instances will be completely removed from the service. Only values of 0 and dds::core::Duration::infinite() are currently supported.

[default] 0

dds::core::policy::HistoryKind dds::core::policy::DurabilityService::history_kind ( ) const

inline

Getter (see setter with the same name)

DurabilityService& dds::core::policy::DurabilityService::history_depth ( int32_t  the_depth )

inline

Controls when the service is able to remove all information regarding a data instances.

When the service cleanup delay is set to 0, disposed instances will be completely removed from the service. Only values of 0 and dds::core::Duration::infinite() are currently supported.

[default] 0

int32_t dds::core::policy::DurabilityService::history_depth ( ) const

inline

Getter (see setter with the same name)

DurabilityService& dds::core::policy::DurabilityService::max_samples ( int32_t  the_max_samples )

inline

Controls when the service is able to remove all information regarding a data instances.

When the service cleanup delay is set to 0, disposed instances will be completely removed from the service. Only values of 0 and dds::core::Duration::infinite() are currently supported.

[default] 0

int32_t dds::core::policy::DurabilityService::max_samples ( ) const

inline

Getter (see setter with the same name)

DurabilityService& dds::core::policy::DurabilityService::max_instances ( int32_t  the_max_instances )

inline

Controls when the service is able to remove all information regarding a data instances.

When the service cleanup delay is set to 0, disposed instances will be completely removed from the service. Only values of 0 and dds::core::Duration::infinite() are currently supported.

[default] 0

DurabilityService& dds::core::policy::DurabilityService::max_samples_per_instance ( int32_t  the_max_samples_per_instance )

inline

Controls when the service is able to remove all information regarding a data instances.

When the service cleanup delay is set to 0, disposed instances will be completely removed from the service. Only values of 0 and dds::core::Duration::infinite() are currently supported.

[default] 0

int32_t dds::core::policy::DurabilityService::max_samples_per_instance ( ) const

inline

Getter (see setter with the same name)