threadschedule::ThreadPriority Class Reference

Value-semantic wrapper for a thread scheduling priority. More...

#include <scheduler_policy.hpp>

Public Member Functions
constexpr	ThreadPriority (int priority=0)
constexpr auto	value () const noexcept -> int
constexpr auto	is_valid () const noexcept -> bool
constexpr auto	operator== (ThreadPriority const &other) const noexcept -> bool
constexpr auto	operator!= (ThreadPriority const &other) const noexcept -> bool
constexpr auto	operator< (ThreadPriority const &other) const noexcept -> bool
constexpr auto	operator<= (ThreadPriority const &other) const noexcept -> bool
constexpr auto	operator> (ThreadPriority const &other) const noexcept -> bool
constexpr auto	operator>= (ThreadPriority const &other) const noexcept -> bool
auto	to_string () const -> std::string

Static Public Member Functions
static constexpr auto	lowest () noexcept -> ThreadPriority
static constexpr auto	normal () noexcept -> ThreadPriority
static constexpr auto	highest () noexcept -> ThreadPriority

Detailed Description

Value-semantic wrapper for a thread scheduling priority.

Encapsulates a single integer priority in the range [-20, 19] - the same range used by POSIX nice values on Linux. The value is silently clamped to this range on construction (via std::clamp), so out-of-range inputs never produce an invalid object.

Semantics

Lower numeric values denote higher scheduling priority (following the Unix nice convention): -20 is the most favourable and 19 is the least.

Platform notes

• Linux: The value is used directly as the nice level for SCHED_OTHER / SCHED_BATCH / SCHED_IDLE, or clamped to the real-time priority range for SCHED_FIFO / SCHED_RR by SchedulerParams::create_for_policy().
• Windows: The value is mapped to a Windows thread priority constant (e.g. THREAD_PRIORITY_HIGHEST, THREAD_PRIORITY_LOWEST) when applied.

Type traits

• Trivially copyable and trivially movable.
• constexpr-constructible - can be used in compile-time contexts.
• All relational operators (==, !=, <, <=, >, >=) are provided and compare the underlying integer value.
• Not thread-safe: concurrent mutation of the same instance requires external synchronisation. Distinct instances may be used freely from different threads.

See also

SchedulerParams::create_for_policy

Definition at line 121 of file scheduler_policy.hpp.

Constructor & Destructor Documentation

ThreadPriority()

threadschedule::ThreadPriority::ThreadPriority ( int priority = 0 )

inlineexplicitconstexpr

Definition at line 124 of file scheduler_policy.hpp.

Referenced by highest(), lowest(), normal(), operator!=(), operator<(), operator<=(), operator==(), operator>(), and operator>=().

Member Function Documentation

highest()

constexpr auto threadschedule::ThreadPriority::highest ( ) -> ThreadPriority

inlinestaticnodiscardconstexprnoexcept

Definition at line 145 of file scheduler_policy.hpp.

References ThreadPriority().

Referenced by threadschedule::profiles::realtime().

is_valid()

auto threadschedule::ThreadPriority::is_valid ( ) const -> bool

inlinenodiscardconstexprnoexcept

Definition at line 132 of file scheduler_policy.hpp.

lowest()

constexpr auto threadschedule::ThreadPriority::lowest ( ) -> ThreadPriority

inlinestaticnodiscardconstexprnoexcept

Definition at line 137 of file scheduler_policy.hpp.

References ThreadPriority().

Referenced by threadschedule::profiles::background().

normal()

constexpr auto threadschedule::ThreadPriority::normal ( ) -> ThreadPriority

inlinestaticnodiscardconstexprnoexcept

Definition at line 141 of file scheduler_policy.hpp.

References ThreadPriority().

Referenced by threadschedule::ScheduledThreadPoolT< ThreadPool >::configure_scheduler_thread(), threadschedule::ChaosController::configure_thread(), threadschedule::HighPerformancePool::configure_threads(), threadschedule::LightweightPoolT< TaskSize >::configure_threads(), threadschedule::PoolWithErrors< HighPerformancePool >::configure_threads(), threadschedule::ScheduledThreadPoolT< ThreadPool >::configure_threads(), threadschedule::ThreadPoolBase< IndefiniteWait >::configure_threads(), and threadschedule::profiles::throughput().

operator!=()

auto threadschedule::ThreadPriority::operator!= ( ThreadPriority const & other ) const -> bool

inlinenodiscardconstexprnoexcept

Definition at line 154 of file scheduler_policy.hpp.

References ThreadPriority().

operator<()

auto threadschedule::ThreadPriority::operator< ( ThreadPriority const & other ) const -> bool

inlinenodiscardconstexprnoexcept

Definition at line 158 of file scheduler_policy.hpp.

References ThreadPriority().

operator<=()

auto threadschedule::ThreadPriority::operator<= ( ThreadPriority const & other ) const -> bool

inlinenodiscardconstexprnoexcept

Definition at line 162 of file scheduler_policy.hpp.

References ThreadPriority().

operator==()

auto threadschedule::ThreadPriority::operator== ( ThreadPriority const & other ) const -> bool

inlinenodiscardconstexprnoexcept

Definition at line 150 of file scheduler_policy.hpp.

References ThreadPriority().

operator>()

auto threadschedule::ThreadPriority::operator> ( ThreadPriority const & other ) const -> bool

inlinenodiscardconstexprnoexcept

Definition at line 166 of file scheduler_policy.hpp.

References ThreadPriority().

operator>=()

auto threadschedule::ThreadPriority::operator>= ( ThreadPriority const & other ) const -> bool

inlinenodiscardconstexprnoexcept

Definition at line 170 of file scheduler_policy.hpp.

References ThreadPriority().

to_string()

auto threadschedule::ThreadPriority::to_string ( ) const -> std::string

inlinenodiscard

Definition at line 175 of file scheduler_policy.hpp.

value()

auto threadschedule::ThreadPriority::value ( ) const -> int

inlinenodiscardconstexprnoexcept

Definition at line 128 of file scheduler_policy.hpp.

Referenced by threadschedule::SchedulerParams::create_for_policy().

---

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

• scheduler_policy.hpp