Standard library header <shared_mutex>

 

C++

Language

Standard Library Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library(C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Iterators library

Ranges library(C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library(C++17)

Regular expressions library(C++11)

Atomic operations library(C++11)

Thread support library(C++11)

Technical Specifications

 

Standard Library headers

Language Support
<cstddef> <cstdlib> <version> <limits> <climits>	<cfloat> <cstdint> <new> <typeinfo>	<source_location> <exception> <initializer_list> <compare>	<coroutine> <csignal> <csetjmp> <cstdarg>
Concepts
<concepts>
Diagnostics
<stdexcept>	<cassert>	<cerrno>	<system_error>
General utilities
<utility> <memory> <memory_resource> <scoped_allocator>	<bitset> <tuple> <optional> <any>	<variant> <type_traits> <ratio> <chrono>	<typeindex> <functional> <ctime>
Strings
<string> <string_view> <cstring>	<charconv> <format>	<cctype> <cwctype>	<cwchar> <cuchar>
Localization
<locale>	<codecvt>	<clocale>
Containers
<span> <array> <vector>	<deque> <forward_list> <list>	<map> <set> <queue>	<unordered_map> <unordered_set> <stack>
Iterators
<iterator>
Ranges
<ranges>
Algorithms
<algorithm>	<execution>
Numerics
<complex> <random>	<valarray> <numeric>	<bit> <numbers>	<cfenv> <cmath>
Input/Output
<iosfwd> <ios> <iomanip> <streambuf>	<istream> <ostream> <iostream>	<sstream> <fstream> <syncstream>	<cstdio> <cinttypes> <strstream>
Regular expressions
<regex>
Filesystem support
<filesystem>
Thread support
<thread> <atomic> <mutex>	<shared_mutex> <condition_variable> <future>	<stop_token> <semaphore>	<latch> <barrier>
C compatibility
<ciso646> <cstdalign>	<cstdbool> <ccomplex>	<ctgmath>

 

This header is part of the thread support library.

Classes
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)
shared_lock (C++14)	implements movable shared mutex ownership wrapper (class template)
Functions
std::swap(std::shared_lock) (C++14)	specialization of std::swap for shared_lock (function template)

Synopsis

namespace std {class shared_mutex;class shared_timed_mutex;template<class Mutex>class shared_lock;template<class Mutex>void swap(shared_lock<Mutex>& x, shared_lock<Mutex>& y)noexcept;}

Class std::shared_mutex

namespace std {class shared_mutex {public: shared_mutex(); ~shared_mutex();   shared_mutex(const shared_mutex&)= delete; shared_mutex& operator=(const shared_mutex&)= delete;   // exclusive ownershipvoid lock();// blockingbool try_lock();void unlock();   // shared ownershipvoid lock_shared();// blockingbool try_lock_shared();void unlock_shared();   using native_handle_type =/* implementation-defined */; native_handle_type native_handle();};}

Class std::shared_timed_mutex

namespace std {class shared_timed_mutex {public: shared_timed_mutex(); ~shared_timed_mutex();   shared_timed_mutex(const shared_timed_mutex&)= delete; shared_timed_mutex& operator=(const shared_timed_mutex&)= delete;   // exclusive ownershipvoid lock();// blockingbool try_lock();template<class Rep, class Period>bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);template<class Clock, class Duration>bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);void unlock();   // shared ownershipvoid lock_shared();// blockingbool try_lock_shared();template<class Rep, class Period>bool try_lock_shared_for(const chrono::duration<Rep, Period>& rel_time);template<class Clock, class Duration>bool try_lock_shared_until(const chrono::time_point<Clock, Duration>& abs_time);void unlock_shared();};}

Class template std::shared_lock

namespace std {template<class Mutex>class shared_lock {public:using mutex_type = Mutex;   // construct/copy/destroy shared_lock()noexcept;explicit shared_lock(mutex_type& m);// blocking shared_lock(mutex_type& m, defer_lock_t)noexcept; shared_lock(mutex_type& m, try_to_lock_t); shared_lock(mutex_type& m, adopt_lock_t);template<class Clock, class Duration> shared_lock(mutex_type& m, const chrono::time_point<Clock, Duration>& abs_time);template<class Rep, class Period> shared_lock(mutex_type& m, const chrono::duration<Rep, Period>& rel_time); ~shared_lock();   shared_lock(const shared_lock&)= delete; shared_lock& operator=(const shared_lock&)= delete;   shared_lock(shared_lock&& u)noexcept; shared_lock& operator=(shared_lock&& u)noexcept;   // lockingvoid lock();// blockingbool try_lock();template<class Rep, class Period>bool try_lock_for(const chrono::duration<Rep, Period>& rel_time);template<class Clock, class Duration>bool try_lock_until(const chrono::time_point<Clock, Duration>& abs_time);void unlock();   // modifiersvoid swap(shared_lock& u)noexcept; mutex_type* release()noexcept;   // observersbool owns_lock()constnoexcept;explicit operator bool()constnoexcept; mutex_type* mutex()constnoexcept;   private: mutex_type* pm;// exposition onlybool owns;// exposition only};   template<class Mutex>void swap(shared_lock<Mutex>& x, shared_lock<Mutex>& y)noexcept;}