OnixS C++ CME Market Data Handler  5.4.0
API documentation
ThreadPoolSettings Class Reference

#include <OnixS/CME/MDH/ThreadPool.h>

Public Member Functions

 ThreadPoolSettings ()
 
 ~ThreadPoolSettings ()
 
const ThreadAffinityaffinity () const
 
ThreadAffinityaffinity ()
 
UInt32 size () const
 
void size (UInt32 value)
 

Detailed Description

The collection of parameters affecting behavior of a thread pool. The given class serves as a base for defining and manipulating thread pool related parameters.

Definition at line 198 of file ThreadPool.h.

Constructor & Destructor Documentation

ThreadPoolSettings ( )
inline

Assigns the default values for the given instance of the thread pool settings.

Definition at line 207 of file ThreadPool.h.

~ThreadPoolSettings ( )
inline

Cleans everything up.

Definition at line 214 of file ThreadPool.h.

Member Function Documentation

const ThreadAffinity& affinity ( ) const
inline

Defines set of CPUs allowed for each working thread to be executed on while running tasks.

Note
By default set is empty thus allowing threads to be executed on any CPU available in the system.

Definition at line 225 of file ThreadPool.h.

ThreadAffinity& affinity ( )
inline

Defines set of CPUs allowed for each working thread to be executed on while running tasks.

Note
By default set is empty thus allowing threads to be executed on any CPU available in the system.

Definition at line 235 of file ThreadPool.h.

UInt32 size ( ) const
inline

Number of working threads in the pool.

Note
Default value is '1'.

Definition at line 244 of file ThreadPool.h.

void size ( UInt32  value)
inline

Defines the number of working threads in the pool.

Definition at line 251 of file ThreadPool.h.


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