Dataflow Runtime API  4.0.1.0
Public Member Functions | List of all members
imt::base::os::linux::ThreadSchedulingParams Class Reference

Provides the parameters required to setup the scheduling of a thread. More...

#include <Imt.Base.OS.Linux/ThreadSchedulingParams.h>

Public Member Functions

constexpr ThreadSchedulingParams (ThreadSchedulingPolicy policy, int32_t priority) noexcept
 Constructor. More...
 
constexpr ThreadSchedulingParams () noexcept
 Constructor Sets the policy to ThreadSchedulingPolicy::OTHER and priority to 0. More...
 
constexpr ThreadSchedulingPolicy getPolicy () const noexcept
 Gets the scheduling policy. More...
 
constexpr int32_t getPriority () const noexcept
 Gets the scheduling priority. More...
 

Detailed Description

Provides the parameters required to setup the scheduling of a thread.

Constructor & Destructor Documentation

◆ ThreadSchedulingParams() [1/2]

constexpr imt::base::os::linux::ThreadSchedulingParams::ThreadSchedulingParams ( ThreadSchedulingPolicy  policy,
int32_t  priority 
)
inlineconstexprnoexcept

Constructor.

Parameters
policyThe scheduling policy
priorityThe thread priority. Corresponds to the realtime priority in case of SchedulingPolicy::FIFO or SchedulingPolicy::ROUND_ROBIN or the nice value in case of SchedulingPolicy::OTHER. See also "man sched 7".

◆ ThreadSchedulingParams() [2/2]

constexpr imt::base::os::linux::ThreadSchedulingParams::ThreadSchedulingParams ( )
inlineconstexprnoexcept

Constructor Sets the policy to ThreadSchedulingPolicy::OTHER and priority to 0.

Member Function Documentation

◆ getPolicy()

constexpr ThreadSchedulingPolicy imt::base::os::linux::ThreadSchedulingParams::getPolicy ( ) const
inlineconstexprnoexcept

Gets the scheduling policy.

Returns
The scheduling policy

◆ getPriority()

constexpr int32_t imt::base::os::linux::ThreadSchedulingParams::getPriority ( ) const
inlineconstexprnoexcept

Gets the scheduling priority.

Returns
the scheduling priority

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