Difference between revisions of "cpp/thread/shared lock"
From cppreference.com
m (Use since= and until= params of {{ddcl}} template.) |
m (mention that exclusive mode is handled by unique_lock) |
||
| Line 6: | Line 6: | ||
}} | }} | ||
| − | The class {{ | + | The class {{tt|shared_lock}} is a general-purpose shared mutex ownership wrapper allowing deferred locking, timed locking and transfer of lock ownership. Locking a {{tt|shared_lock}} locks the associated shared mutex in shared mode (to lock it in exclusive mode, {{lc|std::unique_lock}} can be used) |
The {{tt|shared_lock}} class is movable, but not copyable -- it meets the requirements of {{concept|MoveConstructible}} and {{concept|MoveAssignable}} but not of {{concept|CopyConstructible}} or {{concept|CopyAssignable}}. | The {{tt|shared_lock}} class is movable, but not copyable -- it meets the requirements of {{concept|MoveConstructible}} and {{concept|MoveAssignable}} but not of {{concept|CopyConstructible}} or {{concept|CopyAssignable}}. | ||
Revision as of 07:12, 15 September 2013
| 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. Locking a shared_lock locks the associated shared mutex in shared mode (to lock it in exclusive mode, std::unique_lock can be used)
The shared_lock class is movable, but not copyable -- it meets the requirements of Template:concept and Template:concept but not of Template:concept or Template:concept.
Contents |
Template parameters
| Mutex | - | the type of the shared mutex to lock. The type must meet the Template:concept requirements |
Member types
| Type | Definition |
mutex_type
|
Mutex |
Member functions
constructs a shared_lock, optionally locking the supplied mutex (public member function) | |
| unlocks the associated mutex (public member function) | |
| unlocks the mutex, if owned, and acquires ownership of another (public member function) | |
| | |
| locks the associated mutex (public member function) | |
| tries to lock the associated mutex (public member function) | |
| tries to lock the associated mutex, for the specified duration (public member function) | |
| tries to lock the associated mutex, until a specified time point (public member function) | |
| unlocks the associated mutex (public member function) | |
Modifiers | |
swaps the data members with another shared_lock (public member function) | |
| disassociates the mutex without unlocking (public member function) | |
Observers | |
| returns a pointer to the associated mutex (public member function) | |
| tests whether the lock owns its associated mutex (public member function) | |
| tests whether the lock owns its associated mutex (public member function) | |
Non-member functions
| (C++14) |
specializes the std::swap algorithm (function template) |
