Utility classes for multi-threading. More...

Detailed Description

Utility classes for multi-threading.

Classes
class	PlaybackTimer
	Recurring timer class that allows for playback over a range at given timestamps/intervals. More...

class	StoppableThread
	Extension of a std::thread to allow for signalling the thread to abort its execution. More...

class	ThreadPool
	Lightweight implementation of a thread pool for distributing work onto a fixed number of threads. More...

Enumerations
enum class	Priority { Idle , Lowest , Low , Normal , High , Highest , Critical }
	Enumeration of thread priority levels. More...

Functions
void	setCurrentThreadName (const std::string &threadName)
	Sets the current thread's name to the given string so that a debugger may show it as description.

std::optional< Priority >	currentThreadPriority ()
	Queries the current thread's priority from the operating system or std::nullopt if an error occurred.

bool	setCurrentThreadPriority (Priority priority)
	Sets the current thread's priority to the given value.

void	runAsyncAndForget (std::function< void()> func)
	Launches the given function in a background thread using std::thread This function will return immediately and there is no built-in way to know when func has completed.

Enumeration Type Documentation

enum class Priority

strong

Enumeration of thread priority levels.

Note

Not all operating systems support all priority levels:

On Windows systems there is a 1-to-1 mapping, cf. https://learn.microsoft.com/en-us/windows/win32/api/processthreadsapi/nf-processthreadsapi-setthreadpriority
On Linux systems the enum values are mapped to a niceness value range of -20 to 19
On macOS systems threads can only have "normal status" or "background status". We map Idle and Lowest to background and all other values to normal.

Enumerator
Idle	scheduled as rarely as possible
Lowest	scheduled less often than `Low`
Low	scheduled less often than `Normal`
Normal	default priority of the operating system.
High	scheduled more often than `Normal`.
Highest	scheduled more often than `High`.
Critical	scheduled as often as possible.