ALib C++ Library
Library Version: 2402 R1
Documentation generated by doxygen
Loading...
Searching...
No Matches
Nested Namespaces: | Type Index: | Type Definition Index: | Function Index: | Variable Index:
alib::threads Namespace Reference

Description:

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

Nested Namespaces:

namespace  detail
 

Type Index:

class  Runnable
 
class  Sleeper
 
class  SmartLock
 
class  Thread
 
class  ThreadLock
 
class  ThreadLockNR
 

Type Definition Index:

using ThreadID = integer
 

Function Index:

void Bootstrap ()
 
void Shutdown ()
 

Variable Index:

static constexpr ThreadID UNDEFINED = 0
 

Type Definition Details:

◆ ThreadID

typedef integer ThreadID = integer

Type to store thread identifiers.

Definition at line 34 of file loxpimpl.inl.

Function Details:

◆ Bootstrap()

void Bootstrap ( )

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

The standard bootstrap code of ALib , hence the (overloaded) functions alib::Bootstrap will call this function.

See also
For information about using this method, consult chapter 4.2 Bootstrapping Non-Camp Modules of the ALib Programmer's Manual.

Definition at line 140 of file thread.cpp.

Here is the call graph for this function:

◆ Shutdown()

void Shutdown ( )

Frees resources and shuts down ALib thread logic. Multiple invocations of this method are ignored. The standard bootstrap code of ALib , hence the (overloaded) functions alib::Shutdown will call this function.

See also
Sibling function Bootstrap .

Definition at line 179 of file thread.cpp.

Here is the call graph for this function:

Variable Details:

◆ 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.