OnixS C++ ICE Binary Order Entry Handler 1.1.1
API Documentation
Loading...
Searching...
No Matches
ThreadParams Struct Reference

Public Member Functions

 ThreadParams ()=default
 ThreadParams (std::string name, CpuIndexes affinity, int priority=0, int policy=0)
const std::string & name () const
const CpuIndexesaffinity () const
int priority () const
int policy () const
ThreadParamssetName (std::string name)
ThreadParamssetAffinity (CpuIndexes affinity)
ThreadParamssetPriority (int priority)
ThreadParamssetPolicy (int policy)

Detailed Description

Definition at line 29 of file ServiceFactory.h.

Constructor & Destructor Documentation

◆ ThreadParams() [1/2]

ThreadParams ( )
default

Construct default thread parameters.

Defaults:

  • name: empty
  • affinity: default-constructed
  • priority: 0
  • policy: 0

◆ ThreadParams() [2/2]

ThreadParams ( std::string name,
CpuIndexes affinity,
int priority = 0,
int policy = 0 )
inline

Construct thread parameters with explicit values.

Parameters
nameThread name (for logging/debugging).
affinityCPU affinity mask / CPU index set.
priorityScheduling priority (meaning depends on policy).
policyScheduling policy identifier (platform-specific).

Definition at line 45 of file ServiceFactory.h.

46 : name_(std::move(name))
47 , affinity_(std::move(affinity))
48 , priority_(priority)
49 , policy_(policy)
50 {}

Member Function Documentation

◆ affinity()

const CpuIndexes & affinity ( ) const
inline
Returns
CPU affinity mask / CPU index set.

Definition at line 56 of file ServiceFactory.h.

56{ return affinity_; }

◆ name()

const std::string & name ( ) const
inline
Returns
Thread name.

Definition at line 53 of file ServiceFactory.h.

53{ return name_; }

◆ policy()

int policy ( ) const
inline
Returns
Scheduling policy identifier.

Definition at line 62 of file ServiceFactory.h.

62{ return policy_; }

◆ priority()

int priority ( ) const
inline
Returns
Scheduling priority.

Definition at line 59 of file ServiceFactory.h.

59{ return priority_; }

◆ setAffinity()

ThreadParams & setAffinity ( CpuIndexes affinity)
inline

Sets the CPU affinity.

Parameters
affinityNew CPU affinity mask / CPU index set.

Definition at line 74 of file ServiceFactory.h.

75 {
76 affinity_ = std::move(affinity);
77 return *this;
78 }

◆ setName()

ThreadParams & setName ( std::string name)
inline

Sets the thread name.

Parameters
nameNew thread name.

Definition at line 66 of file ServiceFactory.h.

67 {
68 name_ = std::move(name);
69 return *this;
70 }

◆ setPolicy()

ThreadParams & setPolicy ( int policy)
inline

Sets the scheduling policy.

Parameters
policyNew scheduling policy identifier.

Definition at line 90 of file ServiceFactory.h.

91 {
92 policy_ = policy;
93 return *this;
94 }

◆ setPriority()

ThreadParams & setPriority ( int priority)
inline

Sets the scheduling priority.

Parameters
priorityNew scheduling priority.

Definition at line 82 of file ServiceFactory.h.

83 {
84 priority_ = priority;
85 return *this;
86 }