RTI Connext C# API  6.1.0
ThreadSettings Class Reference

The properties of a thread of execution. More...

Inherits IEquatable< ThreadSettings >.

Public Member Functions

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

Properties

ThreadSettingsKind Mask [get]
 Describes the type of thread. More...
 
int Priority [get]
 Thread priority. More...
 
int StackSize [get]
 The thread stack-size. More...
 
ImmutableList< int > CpuList [get]
 The list of processors on which the thread(s) may run. More...
 
CpuRotationKind CpuRotation [get]
 Determines how processor affinity is applied to multiple threads. More...
 
static ThreadSettings Default [get]
 Singleton containing the default value of a ThreadSettings More...
 

Detailed Description

The properties of a thread of execution.

The full documentation is available in the C API: DDS_ThreadSettings_t

Member Function Documentation

◆ Equals() [1/2]

override bool Equals ( object  other)

Compares for equality

◆ Equals() [2/2]

bool Equals ( ThreadSettings  other)

Compares for equality

◆ GetHashCode()

override int GetHashCode ( )

Gets the hash code

◆ With()

ThreadSettings With ( Action< ThreadSettingsBuilder build)

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

Property Documentation

◆ CpuList

ImmutableList<int> CpuList
get

The list of processors on which the thread(s) may run.

The full documentation is available in the C API: DDS_ThreadSettings_t::cpu_list

◆ CpuRotation

CpuRotationKind CpuRotation
get

Determines how processor affinity is applied to multiple threads.

The full documentation is available in the C API: DDS_ThreadSettings_t::cpu_rotation

◆ Default

ThreadSettings Default
staticget

Singleton containing the default value of a ThreadSettings

◆ Mask

Describes the type of thread.

The full documentation is available in the C API: DDS_ThreadSettings_t::mask

◆ Priority

int Priority
get

Thread priority.

The full documentation is available in the C API: DDS_ThreadSettings_t::priority

◆ StackSize

int StackSize
get

The thread stack-size.

The full documentation is available in the C API: DDS_ThreadSettings_t::stack_size