#include <dispenso/platform.h>

Enumerations
enum class	dispenso::ThreadPriority { kLow , kNormal , kHigh , kRealtime }

Functions
DISPENSO_DLL_ACCESS ThreadPriority	dispenso::getCurrentThreadPriority ()

DISPENSO_DLL_ACCESS bool	dispenso::setCurrentThreadPriority (ThreadPriority prio)

Detailed Description

Utilities for getting and setting thread priority. This is an attempt to unify concepts for thread priority usefully across multiple platforms. For finer control, use platform specific functionality.

Note: When using higher-than-normal priority, use caution! Too many threads running at too high priority can have a strong negative impact on the responsivity of the machine. Prefer to use realtime priority only for short running tasks that need to be very responsively run.

Definition in file priority.h.

Enumeration Type Documentation

◆ ThreadPriority

enum class dispenso::ThreadPriority

strong

A thread priority setting. Enum values in increasing order of priority.

Definition at line 30 of file priority.h.

Function Documentation

◆ getCurrentThreadPriority()

DISPENSO_DLL_ACCESS ThreadPriority dispenso::getCurrentThreadPriority ( )

Access the current thread priority as set by setCurrentThreadPriority.

Returns: The priority of the current thread

Note: If the current thread priority has been set via a platform-specific mechanism, this may return an incorrect value.

◆ setCurrentThreadPriority()

DISPENSO_DLL_ACCESS bool dispenso::setCurrentThreadPriority ( ThreadPriority prio )

Set the current thread's priority

Parameters

prio	The priority to set to

Returns: true if the priority was modified, false otherwise.