This is the reference documentation of sub-namespace threads of the ALib C++ Library, which holds types of library module ALib Threads.

Attention: This module must not be omitted from an ALib Distribution if the using software does not make direct use of this module. If omitted, all other ALib Modules will silently (!) drop the protection of their resources against multi-threaded access.

Further documentation is provided with

ALib Module Threads - Programmer's Manual.
Chapter 2.3.4 Single Threaded Library Compilation of the Programmer's Manual of ALib.

Nested namespaces
	detail

Classes
class	Runnable

class	Sleeper

class	SmartLock

class	Thread

class	ThreadLock

class	ThreadLockNR

Typedefs
using	ThreadID = integer

Variables
static constexpr ThreadID	UNDEFINED = 0

Functions
void	Bootstrap ()

void	Shutdown ()

Typedef Documentation

◆ ThreadID

typedef integer ThreadID

Type to store thread identifiers.

Definition at line 34 of file loxpimpl.inl.

Function Documentation

◆ Bootstrap()

void Bootstrap ( )

Initializes ALib thread logic. Multiple invocations of this method are ignored.

The standard bootstrap code of ALib will invoke this function. Only if fileset Modules is not included in the ALib Distribution, this function has to be invoked "manually".

See also: For information about using this method, consult chapter 3.6 Bootstrapping Small Modules of the ALib Programmer's Manual.

Definition at line 140 of file thread.cpp.

◆ Shutdown()

void Shutdown ( )

Frees resources and shuts down ALib thread logic. Multiple invocations of this method are ignored.

See also: Sibling function Bootstrap.

Definition at line 179 of file thread.cpp.

Here is the call graph for this function:

Variable Documentation

◆ UNDEFINED

constexpr ThreadID UNDEFINED = 0

staticconstexpr

This is a value that may be passed as a value indicating an undefined thread

Definition at line 50 of file thread.hpp.

Nested namespaces

Classes

Typedefs

Variables