Namespaces
Variants
Views
Actions

std::shared_lock

From cppreference.com
< cpp‎ | thread
Revision as of 18:33, 9 July 2013 by P12bot (Talk | contribs)

 
 
Thread support library
Threads
(C++11)
this_thread namespace
(C++11)
(C++11)
(C++11)
Mutual exclusion
(C++11)
Generic lock management
(C++11)
shared_lock
(C++14)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
Condition variables
(C++11)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
 
 
Defined in header <mutex>
template< class Mutex >
class shared_lock;
(since C++14)

The class shared_lock is a general-purpose shared mutex ownership wrapper allowing deferred locking, timed locking and transfer of lock ownership,

The shared_lock class is movable, but not copyable -- it meets the requirements of MoveConstructible and MoveAssignable but not of CopyConstructible or CopyAssignable.

Contents

Template parameters

Mutex - the type of the shared mutex to lock. The type must meet the SharedMutex requirements

Member types

Type Definition
mutex_type Mutex

Member functions

constructs a shared_lock, optionally locking the supplied mutex
(public member function) [edit]
unlocks the associated mutex
(public member function) [edit]
unlocks the mutex, if owned, and acquires ownership of another
(public member function) [edit]
Shared locking
locks the associated mutex
(public member function) [edit]
tries to lock the associated mutex
(public member function) [edit]
tries to lock the associated mutex, for the specified duration
(public member function) [edit]
tries to lock the associated mutex, until a specified time point
(public member function) [edit]
unlocks the associated mutex
(public member function) [edit]
Modifiers
swaps the data members with another shared_lock
(public member function) [edit]
disassociates the mutex without unlocking
(public member function) [edit]
Observers
returns a pointer to the associated mutex
(public member function) [edit]
tests whether the lock owns its associated mutex
(public member function) [edit]
tests whether the lock owns its associated mutex
(public member function) [edit]

Non-member functions

specialization of std::swap for shared_lock
(function template) [edit]