Namespaces
Variants
Views
Actions

std::shared_mutex

From cppreference.com
< cpp‎ | thread
Revision as of 22:29, 31 May 2013 by P12bot (Talk | contribs)

 
 
Thread support library
Threads
(C++11)
this_thread namespace
(C++11)
(C++11)
(C++11)
Mutual exclusion
(C++11)
shared_timed_mutex
(C++14)
Generic lock management
(C++11)
(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>
class shared_mutex;
(since C++14)

The shared_mutex class is a synchronization primitive that can be used to protect shared data from being simultaneously accessed by multiple threads. Differently from other mutex types, there are two levels of access:

  • shared - several threads can share ownership of the same mutex.
  • exclusive - only one thread can own the mutex.

Shared mutexes are usually used in situations, when multiple readers can access the same resource at the same time without causing data races, but only one writer can do so.

In a manner similar to timed_mutex, shared_mutex provides the ability to attempt to claim ownership of a shared_mutex with a timeout via the try_lock_for(), try_lock_until(), try_lock_shared_for(), try_lock_shared_until() methods.

The shared_mutex class is non-copyable.

Member functions

constructs the mutex
(public member function of std::shared_timed_mutex) [edit]
Exclusive locking
locks the mutex, blocks if the mutex is not available
(public member function of std::shared_timed_mutex) [edit]
tries to lock the mutex, returns if the mutex is not available
(public member function of std::shared_timed_mutex) [edit]
tries to lock the mutex, returns if the mutex has been
unavailable for the specified timeout duration
(public member function of std::shared_timed_mutex) [edit]
tries to lock the mutex, returns if the mutex has been
unavailable until specified time point has been reached
(public member function of std::shared_timed_mutex) [edit]
unlocks the mutex
(public member function of std::shared_timed_mutex) [edit]
Shared locking
locks the mutex for shared ownership, blocks if the mutex is not available
(public member function of std::shared_timed_mutex) [edit]
tries to lock the mutex for shared ownership, returns if the mutex is not available
(public member function of std::shared_timed_mutex) [edit]
tries to lock the mutex for shared ownership, returns if the mutex has been
unavailable for the specified timeout duration
(public member function of std::shared_timed_mutex) [edit]
tries to lock the mutex for shared ownership, returns if the mutex has been
unavailable until specified time point has been reached
(public member function of std::shared_timed_mutex) [edit]
unlocks the mutex (shared ownership)
(public member function of std::shared_timed_mutex) [edit]