RTI Connext C# API Version 7.2.0
Rti.Dds.Core.Policy.Durability Class Reference

This QoS policy specifies whether or not DDS will store and deliver previously published data samples to new Subscription.DataReader<T> entities that join the network later. More...

Inherits IEquatable< Durability >.

Public Member Functions

Durability With (Action< DurabilityBuilder > build)
 Creates a new Durability with a set of changes specified in an Action More...
 
override int GetHashCode ()
 Gets the hash code More...
 
override bool Equals (object other)
 Compares for equality More...
 
bool Equals (Durability other)
 Compares for equality More...
 

Static Public Attributes

const int AutoWriterDepth = 0
 A special value used as the default for WriterDepth. More...
 

Properties

DurabilityKind Kind [get]
 The kind of durability. More...
 
bool DirectCommunication [get]
 Indicates whether or not a TRANSIENT or PERSISTENT Subscription.DataReader<T> should receive samples directly from a TRANSIENT or PERSISTENT Publication.DataWriter<T> More...
 
int WriterDepth [get]
 Indicates the number of samples a durable Publication.DataWriter<T> will send to a late joining Subscription.DataReader<T>. More...
 
PersistentStorageSettings StorageSettings [get]
 Configures durable writer history and durable reader state More...
 
static Durability Default [get]
 Singleton containing the default value of a Durability More...
 

Detailed Description

This QoS policy specifies whether or not DDS will store and deliver previously published data samples to new Subscription.DataReader<T> entities that join the network later.

Member Function Documentation

◆ With()

Durability Rti.Dds.Core.Policy.Durability.With ( Action< DurabilityBuilder build)
inline

Creates a new Durability with a set of changes specified in an Action

Parameters
buildAn Action (typically a lambda function) that receives a modifiable object with the current values of this Durability.
Returns
A new Durability with the changes applied by the Action

◆ GetHashCode()

override int Rti.Dds.Core.Policy.Durability.GetHashCode ( )
inline

Gets the hash code

◆ Equals() [1/2]

override bool Rti.Dds.Core.Policy.Durability.Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Rti.Dds.Core.Policy.Durability.Equals ( Durability  other)
inline

Compares for equality

Field Documentation

◆ AutoWriterDepth

const int Rti.Dds.Core.Policy.Durability.AutoWriterDepth = 0
static

A special value used as the default for WriterDepth.

The full documentation is available in the C API: DDSDurabilityQosPolicyAUTO_WRITER_DEPTH

Property Documentation

◆ Kind

DurabilityKind Rti.Dds.Core.Policy.Durability.Kind
get

The kind of durability.

The full documentation is available in the C API: DDS_DurabilityQosPolicy_kind

◆ DirectCommunication

bool Rti.Dds.Core.Policy.Durability.DirectCommunication
get

Indicates whether or not a TRANSIENT or PERSISTENT Subscription.DataReader<T> should receive samples directly from a TRANSIENT or PERSISTENT Publication.DataWriter<T>

The full documentation is available in the C API: DDS_DurabilityQosPolicy_direct_communication

◆ WriterDepth

int Rti.Dds.Core.Policy.Durability.WriterDepth
get

Indicates the number of samples a durable Publication.DataWriter<T> will send to a late joining Subscription.DataReader<T>.

The full documentation is available in the C API: DDS_DurabilityQosPolicy_writer_depth

◆ StorageSettings

PersistentStorageSettings Rti.Dds.Core.Policy.Durability.StorageSettings
get

Configures durable writer history and durable reader state

The full documentation is available in the C API: DDS_DurabilityQosPolicy_storage_settings

◆ Default

Durability Rti.Dds.Core.Policy.Durability.Default
staticget

Singleton containing the default value of a Durability