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

Configures an AsyncWaitSet, which is also the object that manages a Subscription.SampleProcessor. More...

Inherits IEquatable< AsyncWaitSetProperty >.

Public Member Functions

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

Properties

WaitSetProperty WaitsetProperty [get]
 Specifies the behavior of the asynchronous wait, which is equivalent to the wait mechanism of a WaitSet. More...
 
uint ThreadPoolSize [get]
 Number of threads that conform the thread pool of the AsyncWaitSet. More...
 
ThreadSettings ThreadSettings [get]
 Configures each thread in the thread pool More...
 
string ThreadNamePrefix [get]
 Prefix used to composed the name of each thread. More...
 
Duration WaitTimeout [get]
 Asynchronous wait timeout. More...
 
int Level [get]
 Specifies the level of an AsyncWaitSet. More...
 
static AsyncWaitSetProperty Default = CreateDefault() [get]
 Singleton containing the default value of a AsyncWaitSetProperty More...
 

Detailed Description

Configures an AsyncWaitSet, which is also the object that manages a Subscription.SampleProcessor.

Member Function Documentation

◆ With()

AsyncWaitSetProperty Rti.Dds.Core.AsyncWaitSetProperty.With ( Action< AsyncWaitSetPropertyBuilder build)
inline

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

◆ GetHashCode()

override int Rti.Dds.Core.AsyncWaitSetProperty.GetHashCode ( )
inline

Gets the hash code

◆ Equals() [1/2]

override bool Rti.Dds.Core.AsyncWaitSetProperty.Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Rti.Dds.Core.AsyncWaitSetProperty.Equals ( AsyncWaitSetProperty  other)
inline

Compares for equality

Property Documentation

◆ WaitsetProperty

WaitSetProperty Rti.Dds.Core.AsyncWaitSetProperty.WaitsetProperty
get

Specifies the behavior of the asynchronous wait, which is equivalent to the wait mechanism of a WaitSet.

The full documentation is available in the C API: DDS_AsyncWaitSetProperty_t_waitset_property

◆ ThreadPoolSize

uint Rti.Dds.Core.AsyncWaitSetProperty.ThreadPoolSize
get

Number of threads that conform the thread pool of the AsyncWaitSet.

The full documentation is available in the C API: DDS_AsyncWaitSetProperty_t_thread_pool_size

◆ ThreadSettings

ThreadSettings Rti.Dds.Core.AsyncWaitSetProperty.ThreadSettings
get

Configures each thread in the thread pool

The full documentation is available in the C API: DDS_AsyncWaitSetProperty_t_thread_settings

◆ ThreadNamePrefix

string Rti.Dds.Core.AsyncWaitSetProperty.ThreadNamePrefix
get

Prefix used to composed the name of each thread.

The full documentation is available in the C API: DDS_AsyncWaitSetProperty_t_thread_name_prefix

◆ WaitTimeout

Duration Rti.Dds.Core.AsyncWaitSetProperty.WaitTimeout
get

Asynchronous wait timeout.

The full documentation is available in the C API: DDS_AsyncWaitSetProperty_t_wait_timeout

◆ Level

int Rti.Dds.Core.AsyncWaitSetProperty.Level
get

Specifies the level of an AsyncWaitSet.

The full documentation is available in the C API: DDS_AsyncWaitSetProperty_t_level

◆ Default

AsyncWaitSetProperty Rti.Dds.Core.AsyncWaitSetProperty.Default = CreateDefault()
staticget

Singleton containing the default value of a AsyncWaitSetProperty