RTI Connext C# API Version 7.3.0
Rti.Dds.Core.Policy.WriterDataLifecycle Class Reference

Controls how a Publication.DataWriter<T> handles the lifecycle of the instances (keys) that it writes. More...

Inherits IEquatable< WriterDataLifecycle >.

Public Member Functions

WriterDataLifecycle With (Action< WriterDataLifecycleBuilder > build)
 Creates a new WriterDataLifecycle 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 (WriterDataLifecycle other)
 Compares for equality More...
 

Properties

bool AutodisposeUnregisteredInstances [get]
 Boolean flag that controls the behavior when the Publication.DataWriter<T> unregisters an instance by means of the unregister operations. More...
 
Duration AutopurgeUnregisteredInstancesDelay [get]
 Maximum duration for which the Publication.DataWriter<T> will maintain information regarding an instance once it has unregistered the instance. More...
 
Duration AutopurgeDisposedInstancesDelay [get]
 Maximum duration for which the Publication.DataWriter<T> will maintain information regarding an instance once it has disposed the instance. More...
 
static WriterDataLifecycle Default [get]
 Singleton containing the default value of a WriterDataLifecycle More...
 

Detailed Description

Controls how a Publication.DataWriter<T> handles the lifecycle of the instances (keys) that it writes.

The full documentation is available in the C API: DDS_WriterDataLifecycleQosPolicy

Member Function Documentation

◆ With()

WriterDataLifecycle Rti.Dds.Core.Policy.WriterDataLifecycle.With ( Action< WriterDataLifecycleBuilder build)
inline

Creates a new WriterDataLifecycle 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 WriterDataLifecycle.
Returns
A new WriterDataLifecycle with the changes applied by the Action

◆ GetHashCode()

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

Gets the hash code

◆ Equals() [1/2]

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

Compares for equality

◆ Equals() [2/2]

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

Compares for equality

Property Documentation

◆ AutodisposeUnregisteredInstances

bool Rti.Dds.Core.Policy.WriterDataLifecycle.AutodisposeUnregisteredInstances
get

Boolean flag that controls the behavior when the Publication.DataWriter<T> unregisters an instance by means of the unregister operations.

The full documentation is available in the C API: DDS_WriterDataLifecycleQosPolicy_autodispose_unregistered_instances

◆ AutopurgeUnregisteredInstancesDelay

Duration Rti.Dds.Core.Policy.WriterDataLifecycle.AutopurgeUnregisteredInstancesDelay
get

Maximum duration for which the Publication.DataWriter<T> will maintain information regarding an instance once it has unregistered the instance.

The full documentation is available in the C API: DDS_WriterDataLifecycleQosPolicy_autopurge_unregistered_instances_delay

◆ AutopurgeDisposedInstancesDelay

Duration Rti.Dds.Core.Policy.WriterDataLifecycle.AutopurgeDisposedInstancesDelay
get

Maximum duration for which the Publication.DataWriter<T> will maintain information regarding an instance once it has disposed the instance.

The full documentation is available in the C API: DDS_WriterDataLifecycleQosPolicy_autopurge_disposed_instances_delay

◆ Default

WriterDataLifecycle Rti.Dds.Core.Policy.WriterDataLifecycle.Default
staticget

Singleton containing the default value of a WriterDataLifecycle