std::shared_lock::shared_lock

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Technical Specifications

 

Thread support library

Threads
thread (C++11)
this_thread namespace
get_id (C++11) yield (C++11)	sleep_for (C++11) sleep_until (C++11)
Mutual exclusion
mutex (C++11) recursive_mutex (C++11) shared_mutex (C++17)	timed_mutex (C++11) recursive_timed_mutex (C++11) shared_timed_mutex (C++14)
Generic lock management
lock_guard (C++11) unique_lock (C++11) shared_lock (C++14) defer_lock_ttry_to_lock_tadopt_lock_t (C++11)(C++11)(C++11)	lock (C++11) try_lock (C++11) defer_locktry_to_lockadopt_lock (C++11)(C++11)(C++11) once_flag (C++11) call_once (C++11)
Condition variables
condition_variable (C++11)
condition_variable_any (C++11)
notify_all_at_thread_exit (C++11)
cv_status (C++11)
Futures
promise (C++11) future (C++11) shared_future (C++11) packaged_task (C++11) async (C++11)	launch (C++11) future_status (C++11) future_error (C++11) future_category (C++11) future_errc (C++11)

 

std::shared_lock

Member functions

shared_lock::shared_lock

shared_lock::~shared_lock

shared_lock::operator=

Shared locking

shared_lock::lock

shared_lock::try_lock

shared_lock::try_lock_for

shared_lock::try_lock_until

shared_lock::unlock

Modifiers

shared_lock::swap

shared_lock::release

Observers

shared_lock::mutex

shared_lock::owns_lock

shared_lock::operator bool

Non-member functions

std::swap(shared_lock)

 

shared_lock();	(1)	(since C++14)
shared_lock( shared_lock&& other );	(2)	(since C++14)
explicit shared_lock( mutex_type& m );	(3)	(since C++14)
shared_lock( mutex_type& m, std::defer_lock_t t );	(4)	(since C++14)
shared_lock( mutex_type& m, std::try_to_lock_t t );	(5)	(since C++14)
shared_lock( mutex_type& m, std::adopt_lock_t t );	(6)	(since C++14)
template< class Rep, class Period > shared_lock( mutex_type& m,              const std::chrono::duration<Rep,Period>& timeout_duration );	(7)	(since C++14)
template< class Clock, class Duration > shared_lock( mutex_type& m,              const std::chrono::time_point<Clock,Duration>& timeout_time );	(8)	(since C++14)

Constructs a shared_lock, optionally locking the supplied mutex.

1) Constructs a shared_lock with no associated mutex.

2) Move constructor. Initializes the shared_lock with the contents of other. Leaves other with no associated mutex.

3-8) Constructs a shared_lock with m as the associated mutex. Additionally:

3) Locks the associated mutex in shared mode by calling m.lock_shared(). The behavior is undefined if this thread already owns the mutex in any mode.

4) Does not lock the associated mutex.

5) Tries to lock the associated mutex in shared mode without blocking by calling m.try_lock_shared(). The behavior is undefined if this thread already owns the mutex in any mode.

6) Assumes the calling thread already owns m in shared mode.

7) Tries to lock the associated mutex in shared mode by calling m.try_lock_shared_until(timeout_duration), which blocks until specified timeout_duration has elapsed or the lock is acquired, whichever comes first. May block for longer than timeout_duration. The behavior is undefined if this thread already owns the mutex in any mode.

8) Tries to lock the associated mutex in shared mode by calling m.try_lock_shared_for(timeout_time), which blocks until specified timeout_time has been reached or the lock is acquired, whichever comes first. May block for longer than until timeout_time has been reached. The behavior is undefined if this thread already owns the mutex in any mode.

Parameters

other	-	another shared_lock to initialize the state with
m	-	mutex to associate with the lock and optionally acquire ownership of
t	-	tag parameter used to select constructors with different locking strategies
timeout_duration	-	maximum duration to block for
timeout_time	-	maximum time point to block until

Exceptions

1,2,4)

noexcept specification:  

noexcept