RTI Connext C API Version 7.4.0
All Data Structures Functions Variables Typedefs Enumerations Enumerator Modules Pages
DDS_DurabilityServiceQosPolicy Struct Reference

<<spec>> Various settings to configure the external RTI Persistence Service used by RTI Connext for DataWriters with a DDS_DurabilityQosPolicy setting of DDS_PERSISTENT_DURABILITY_QOS or DDS_TRANSIENT_DURABILITY_QOS. More...

Data Fields

struct DDS_Duration_t service_cleanup_delay
 <<spec>> Controls when the service is able to remove all information regarding a data instances. More...
 
DDS_HistoryQosPolicyKind history_kind
 <<spec>> The kind of history to apply in recouping durable data. More...
 
DDS_Long history_depth
 <<spec>> Setting to use for the DDS_DurabilityQosPolicy::writer_depth when recouping durable data. More...
 
DDS_Long max_samples
 <<spec>> Part of resource limits QoS policy to apply when feeding a late joiner. More...
 
DDS_Long max_instances
 <<spec>> Part of resource limits QoS policy to apply when feeding a late joiner. More...
 
DDS_Long max_samples_per_instance
 <<spec>> Part of resource limits QoS policy to apply when feeding a late joiner. More...
 

Detailed Description

<<spec>> Various settings to configure the external RTI Persistence Service used by RTI Connext for DataWriters with a DDS_DurabilityQosPolicy setting of DDS_PERSISTENT_DURABILITY_QOS or DDS_TRANSIENT_DURABILITY_QOS.

Entity:
DDS_Topic, DDS_DataWriter
Properties:
RxO = NO
Changeable = UNTIL ENABLE
See also
DURABILITY
HISTORY
RESOURCE_LIMITS

Usage

When a DataWriter's DDS_DurabilityQosPolicy::kind is DDS_PERSISTENT_DURABILITY_QOS or DDS_TRANSIENT_DURABILITY_QOS, an external service, the RTI Persistence Service, is used to store and possibly forward the data sent by the DDS_DataWriter to DDS_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_DataWriter, such as how much data to store. For example, it configures the DURABILITY, 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.

Field Documentation

◆ service_cleanup_delay

struct DDS_Duration_t DDS_DurabilityServiceQosPolicy::service_cleanup_delay

<<spec>> 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_DURATION_INFINITE are currently supported.

[default] 0

Categories
Immutable, Discovery Metadata, Durability, Instance Lifecycle, Data Availability

◆ history_kind

DDS_HistoryQosPolicyKind DDS_DurabilityServiceQosPolicy::history_kind

<<spec>> The kind of history to apply in recouping durable data.

[default] DDS_KEEP_LAST_HISTORY_QOS

Categories
Immutable, Discovery Metadata, Durability, Applied Per-Instance, Sample Memory Management

◆ history_depth

DDS_Long DDS_DurabilityServiceQosPolicy::history_depth

<<spec>> Setting to use for the DDS_DurabilityQosPolicy::writer_depth when recouping durable data.

If the DDS_HistoryQosPolicy::depth is set to a value lower than this value, DDS_HistoryQosPolicy::depth will be set equal to the value of this field.

[default] DDS_AUTO_WRITER_DEPTH (1)

Categories
Immutable, Discovery Metadata, Durability, Applied Per-Instance, Sample Memory Management

◆ max_samples

DDS_Long DDS_DurabilityServiceQosPolicy::max_samples

<<spec>> Part of resource limits QoS policy to apply when feeding a late joiner.

[default] DDS_LENGTH_UNLIMITED

Categories
Immutable, Discovery Metadata, Durability, Sample Memory Management, Middleware Memory Management, Data Availability

◆ max_instances

DDS_Long DDS_DurabilityServiceQosPolicy::max_instances

<<spec>> Part of resource limits QoS policy to apply when feeding a late joiner.

[default] DDS_LENGTH_UNLIMITED

Categories
Immutable, Discovery Metadata, Durability, Instance Lifecycle, Sample Memory Management, Middleware Memory Management, Data Availability

◆ max_samples_per_instance

DDS_Long DDS_DurabilityServiceQosPolicy::max_samples_per_instance

<<spec>> Part of resource limits QoS policy to apply when feeding a late joiner.

[default] DDS_LENGTH_UNLIMITED

Categories
Immutable, Discovery Metadata, Durability, Instance Lifecycle, Sample Memory Management, Middleware Memory Management, Data Availability