C++ named requirements: BasicLockable (since C++11)
From cppreference.com
C++
Feature test macros (C++20)
Concepts library (C++20)
Metaprogramming library (C++11)
Ranges library (C++20)
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
C++ named requirements
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++17)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++17)
(C++20)
(C++20)
(C++20)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
BasicLockable
(C++11)
(C++11)
(C++11)
(C++14)
(C++14)
(C++11)
(C++11)
(C++17)
(C++14)
(C++20)
(C++20)
(C++23)
(C++23)
(C++23)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
The BasicLockable requirements describe the minimal characteristics of types that provide exclusive blocking semantics for execution agents (i.e. threads).
[edit] Requirements
For type L to be BasicLockable, the following conditions have to be satisfied for an object m of type L:
| Expression | Preconditions | Effects |
|---|---|---|
| m.lock() | Blocks until a lock can be acquired for the current execution agent (thread, process, task). If an exception is thrown, no lock is acquired. | |
| m.unlock() | The current execution agent holds a non-shared lock on m.
|
Releases the non-shared lock held by the execution agent.
Throws no exceptions. |
[edit]
A lock on an object is said to be non-shared lock if it is acquired by a call to lock, try_lock, try_lock_for, or try_lock_until member function.
[edit] Standard library
The following standard library types satisfy BasicLockable requirements:
(C++11)
(class) [edit]
(C++11)
by the same thread and implements locking with a timeout
(class) [edit]
(C++14)
(class) [edit]