# C++ named requirements: BasicLockable (since C++11)

> C++ Atlas: `cppatlas.com/w/cpp/named_req/BasicLockable` | Source: https://en.cppreference.com/w/cpp/named_req/BasicLockable | Domain: Named Requirements | Standards: C++11, C++14, C++17

The BasicLockable requirements describe the minimal characteristics of types that provide exclusive blocking semantics for execution agents (i.e. threads).

## Official Specification Summary (cppreference)

The *BasicLockable* requirements describe the minimal characteristics of types that provide exclusive blocking semantics for execution agents (i.e. threads).

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

#### Non-shared locks

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.

### Standard library

The following standard library types satisfy *BasicLockable* requirements:

- `mutex` (C++11): provides basic mutual exclusion facility (class)
- `recursive_mutex` (C++11): provides mutual exclusion facility which can be locked recursively by the same thread (class)
- `recursive_timed_mutex` (C++11): provides mutual exclusion facility which can be locked recursively by the same thread and implements locking with a timeout (class)
- `shared_mutex` (C++17): provides shared mutual exclusion facility (class)
- `shared_timed_mutex` (C++14): provides shared mutual exclusion facility and implements locking with a timeout (class)
- `timed_mutex` (C++11): provides mutual exclusion facility which implements locking with a timeout (class)

### See also

- [Thread support library](https://en.cppreference.com/w/cpp/thread)
- [*Mutex*](https://en.cppreference.com/w/cpp/named_req/Mutex)
- [*Lockable*](https://en.cppreference.com/w/cpp/named_req/Lockable)
- [*TimedLockable*](https://en.cppreference.com/w/cpp/named_req/TimedLockable)

---
Attribution: content from https://en.cppreference.com/w/cpp/named_req/BasicLockable (cppreference.com), licensed under CC-BY-SA 3.0 and GFDL. Modified: converted to markdown, study notes added. Offline snapshot of 9 February 2025.