PLCnext API Documentation  22.9.0.33
Public Member Functions | Public Attributes | List of all members
Arp::System::Commons::Threading::ThreadSettings Class Reference

Container class for adaptable thread settings. More...

#include <ThreadSettings.hpp>

Public Member Functions

 ThreadSettings (void)
 Constructs an ThreadSettings instance. More...
 
 ThreadSettings (const String &name, size_t priority=0, size_t cpuAffinity=0, size_t stackSize=0)
 Constructs an ThreadSettings instance. More...
 
 ~ThreadSettings (void)=default
 Destructs this instance and frees all resources. More...
 

Public Attributes

String Name
 Name for the thread. More...
 
size_t Priority
 Priority of thread. More...
 
size_t CpuAffinity
 CPU affinity mask determine which CPU is allowed to run the thread. More...
 
size_t StackSize
 Bytes-size of requested stack for new thread. More...
 

Detailed Description

Container class for adaptable thread settings.

Constructor & Destructor Documentation

◆ ThreadSettings() [1/2]

Arp::System::Commons::Threading::ThreadSettings::ThreadSettings ( void  )
inline

Constructs an ThreadSettings instance.

◆ ThreadSettings() [2/2]

Arp::System::Commons::Threading::ThreadSettings::ThreadSettings ( const String name,
size_t  priority = 0,
size_t  cpuAffinity = 0,
size_t  stackSize = 0 
)
inline

Constructs an ThreadSettings instance.

◆ ~ThreadSettings()

Arp::System::Commons::Threading::ThreadSettings::~ThreadSettings ( void  )
default

Destructs this instance and frees all resources.

Member Data Documentation

◆ CpuAffinity

size_t Arp::System::Commons::Threading::ThreadSettings::CpuAffinity

CPU affinity mask determine which CPU is allowed to run the thread.

See Arp::System::Commons::Threading::Thread::SetCpuAffinity for more information.

◆ Name

String Arp::System::Commons::Threading::ThreadSettings::Name

Name for the thread.

◆ Priority

size_t Arp::System::Commons::Threading::ThreadSettings::Priority

Priority of thread.

◆ StackSize

size_t Arp::System::Commons::Threading::ThreadSettings::StackSize

Bytes-size of requested stack for new thread.


The documentation for this class was generated from the following file: