Difference between revisions of "cpp/named req/SharedLockable"
From cppreference.com
(Explicitly specifiy shared lock.) |
m (+C++14 in title) |
||
| Line 1: | Line 1: | ||
| − | {{cpp/named req/title|SharedLockable}} | + | {{cpp/named req/title|SharedLockable|notes={{mark since c++14}}}} |
{{cpp/named req/navbar}} | {{cpp/named req/navbar}} | ||
Latest revision as of 12:22, 8 November 2022
The SharedLockable requirements describe the minimal characteristics of types that provide shared blocking semantics for execution agents (i.e. threads).
[edit] Requirements
For type L to be SharedLockable, the following conditions have to be satisfied for an object m of type L:
| Expression | Preconditions | Effects | Return value |
|---|---|---|---|
| m.lock_shared() | Blocks until a lock can be obtained for the current execution agent (thread, process, task). If an exception is thrown, no lock is obtained. | ||
| m.try_lock_shared() | Attempts to obtain a lock for the current execution agent (thread, process, task) without blocking. If an exception is thrown, no lock is obtained. | true if the lock was obtained, false otherwise | |
| m.unlock_shared() | The current execution agent holds a shared lock on m.
|
Releases the shared lock held by the execution agent.
Throws no exceptions. |
[edit]
A lock on an object is said to be shared lock if it is acquired by a call to lock_shared, try_lock_shared, try_lock_shared_for, or try_lock_shared_until member function.
