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

Instance replacement kind applied to each instance state. More...

Inherits IEquatable< InstanceReplacementSettings >.

Public Member Functions

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

Properties

InstanceRemovalKind AliveInstanceRemoval [get]
 Removal kind applied to alive Omg.Dds.Subscription.InstanceState.Alive)) instances. More...
 
InstanceRemovalKind DisposedInstanceRemoval [get]
 Removal kind applied to disposed (Omg.Dds.Subscription.InstanceState.NotAliveDisposed) instances. More...
 
InstanceRemovalKind NoWritersInstanceRemoval [get]
 Removal kind applied to fully-unregistered (Omg.Dds.Subscription.InstanceState.NotAliveNoWriters) instances. More...
 
static InstanceReplacementSettings Default [get]
 Singleton containing the default value of a InstanceReplacementSettings More...
 

Detailed Description

Instance replacement kind applied to each instance state.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsInstanceReplacementSettings

Member Function Documentation

◆ With()

InstanceReplacementSettings Rti.Dds.Core.Policy.InstanceReplacementSettings.With ( Action< InstanceReplacementSettingsBuilder build)
inline

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

◆ GetHashCode()

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

Gets the hash code

◆ Equals() [1/2]

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

Compares for equality

◆ Equals() [2/2]

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

Compares for equality

Property Documentation

◆ AliveInstanceRemoval

InstanceRemovalKind Rti.Dds.Core.Policy.InstanceReplacementSettings.AliveInstanceRemoval
get

Removal kind applied to alive Omg.Dds.Subscription.InstanceState.Alive)) instances.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsInstanceReplacementSettings_alive_instance_removal

◆ DisposedInstanceRemoval

InstanceRemovalKind Rti.Dds.Core.Policy.InstanceReplacementSettings.DisposedInstanceRemoval
get

Removal kind applied to disposed (Omg.Dds.Subscription.InstanceState.NotAliveDisposed) instances.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsInstanceReplacementSettings_disposed_instance_removal

◆ NoWritersInstanceRemoval

InstanceRemovalKind Rti.Dds.Core.Policy.InstanceReplacementSettings.NoWritersInstanceRemoval
get

Removal kind applied to fully-unregistered (Omg.Dds.Subscription.InstanceState.NotAliveNoWriters) instances.

The full documentation is available in the C API: DDS_DataReaderResourceLimitsInstanceReplacementSettings_no_writers_instance_removal

◆ Default

InstanceReplacementSettings Rti.Dds.Core.Policy.InstanceReplacementSettings.Default
staticget

Singleton containing the default value of a InstanceReplacementSettings