RTI Connext Java API Version 7.1.0
DurabilityServiceQosPolicy Class Reference

Various settings to configure the external RTI Persistence Service used by RTI Connext for DataWriters with a com.rti.dds.infrastructure.DurabilityQosPolicy setting of com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.PERSISTENT_DURABILITY_QOS or com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TRANSIENT_DURABILITY_QOS. More...

Inheritance diagram for DurabilityServiceQosPolicy:
QosPolicy

Public Attributes

final Duration_t service_cleanup_delay
 Controls when the service is able to remove all information regarding a data instances. More...
 
HistoryQosPolicyKind history_kind
 The kind of history to apply in recouping durable data. More...
 
int history_depth
 Setting to use for the com.rti.dds.infrastructure.DurabilityQosPolicy.writer_depth when recouping durable data. More...
 
int max_samples
 Part of resource limits QoS policy to apply when feeding a late joiner. More...
 
int max_instances
 Part of resource limits QoS policy to apply when feeding a late joiner. More...
 
int max_samples_per_instance
 Part of resource limits QoS policy to apply when feeding a late joiner. More...
 
- Public Attributes inherited from QosPolicy
final QosPolicyId_t id
 The ID of this QoS policy. More...
 
final String policy_name
 The name of this QoS policy. More...
 

Detailed Description

Various settings to configure the external RTI Persistence Service used by RTI Connext for DataWriters with a com.rti.dds.infrastructure.DurabilityQosPolicy setting of com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.PERSISTENT_DURABILITY_QOS or com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TRANSIENT_DURABILITY_QOS.

Entity:
com.rti.dds.topic.Topic, com.rti.dds.publication.DataWriter
Properties:
RxO = NO
Changeable = UNTIL ENABLE
See also
DURABILITY
HISTORY
RESOURCE_LIMITS

Usage

When a DataWriter's com.rti.dds.infrastructure.DurabilityQosPolicy.kind is com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.PERSISTENT_DURABILITY_QOS or com.rti.dds.infrastructure.DurabilityQosPolicyKind.DurabilityQosPolicyKind.TRANSIENT_DURABILITY_QOS, an external service, the RTI Persistence Service, is used to store and possibly forward the data sent by the com.rti.dds.publication.DataWriter to com.rti.dds.subscription.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 com.rti.dds.publication.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.

Member Data Documentation

◆ service_cleanup_delay

final Duration_t service_cleanup_delay
Initial value:
= new Duration_t(
Duration_t.DURATION_INFINITE_SEC, Duration_t.DURATION_INFINITE_NSEC)

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 com.rti.dds.infrastructure.Duration_t.DURATION_INFINITE are currently supported.

[default] 0

◆ history_kind

HistoryQosPolicyKind history_kind

The kind of history to apply in recouping durable data.

[default] com.rti.dds.infrastructure.HistoryQosPolicyKind.HistoryQosPolicyKind.KEEP_LAST_HISTORY_QOS

◆ history_depth

int history_depth

Setting to use for the com.rti.dds.infrastructure.DurabilityQosPolicy.writer_depth when recouping durable data.

If the com.rti.dds.infrastructure.HistoryQosPolicy.depth is set to a value lower than this value, com.rti.dds.infrastructure.HistoryQosPolicy.depth will be set equal to the value of this field.

[default] com.rti.dds.infrastructure.DurabilityQosPolicy.AUTO_WRITER_DEPTH (1)

◆ max_samples

int max_samples

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

[default] com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED

◆ max_instances

int max_instances

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

[default] com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED

◆ max_samples_per_instance

int max_samples_per_instance

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

[default] com.rti.dds.infrastructure.ResourceLimitsQosPolicy.LENGTH_UNLIMITED