ThreadSchedule 3.0.0
Modern C++ thread management library
Loading...
Searching...
No Matches
threadschedule::realtime_priority Class Reference

Strongly-typed realtime priority in the range $[1, 99]$. More...

#include <realtime_priority.hpp>

Public Member Functions

constexpr realtime_priority (int value)
 Construct and validate a realtime priority.
 
constexpr auto value () const noexcept -> int
 Return the wrapped realtime priority value.
 

Static Public Member Functions

static auto create (int value) noexcept -> result< realtime_priority >
 Construct a realtime priority without exceptions.
 

Static Public Attributes

static constexpr int minimum = 1
 Lowest accepted realtime priority value.
 
static constexpr int maximum = 99
 Highest accepted realtime priority value.
 

Friends

constexpr auto operator== (realtime_priority lhs, realtime_priority rhs) noexcept -> bool
 
constexpr auto operator!= (realtime_priority lhs, realtime_priority rhs) noexcept -> bool
 

Detailed Description

Strongly-typed realtime priority in the range $[1, 99]$.

Definition at line 18 of file realtime_priority.hpp.

Constructor & Destructor Documentation

◆ realtime_priority()

constexpr threadschedule::realtime_priority::realtime_priority ( int  value)
inlineexplicitconstexpr

Construct and validate a realtime priority.

Parameters
valueRealtime priority in the range minimum .. maximum.
Exceptions
std::invalid_argumentif value is out of range.

Definition at line 31 of file realtime_priority.hpp.

Member Function Documentation

◆ create()

static auto threadschedule::realtime_priority::create ( int  value) -> result<realtime_priority>
inlinestaticnoexcept

Construct a realtime priority without exceptions.

Parameters
valueRealtime priority in the range minimum .. maximum.
Returns
A valid realtime_priority or errc::invalid_argument.

Definition at line 39 of file realtime_priority.hpp.

References maximum, and value().

◆ value()

constexpr auto threadschedule::realtime_priority::value ( ) const -> int
inlineconstexprnoexcept

Return the wrapped realtime priority value.

Definition at line 48 of file realtime_priority.hpp.

Referenced by create().

Friends And Related Symbol Documentation

◆ operator!=

constexpr auto operator!= ( realtime_priority  lhs,
realtime_priority  rhs 
) -> bool
friend

Definition at line 59 of file realtime_priority.hpp.

◆ operator==

constexpr auto operator== ( realtime_priority  lhs,
realtime_priority  rhs 
) -> bool
friend

Definition at line 54 of file realtime_priority.hpp.

Member Data Documentation

◆ maximum

constexpr int threadschedule::realtime_priority::maximum = 99
staticconstexpr

Highest accepted realtime priority value.

Definition at line 24 of file realtime_priority.hpp.

Referenced by create().

◆ minimum

constexpr int threadschedule::realtime_priority::minimum = 1
staticconstexpr

Lowest accepted realtime priority value.

Definition at line 22 of file realtime_priority.hpp.


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