Difference between revisions of "Template:cpp/thread/mutex/try lock"
From cppreference.com
(ub note) |
m |
||
| Line 9: | Line 9: | ||
Tries to lock the mutex. Returns immediately. On successful lock acquisition returns {{c|true}}, otherwise returns {{c|false}}. | Tries to lock the mutex. Returns immediately. On successful lock acquisition returns {{c|true}}, otherwise returns {{c|false}}. | ||
| − | This function is allowed to fail spuriously and return {{c|false}} even if the mutex is not | + | This function is allowed to fail spuriously and return {{c|false}} even if the mutex is not currently locked by any other thread. |
{{#switch:{{{1}}} | {{#switch:{{{1}}} | ||
Revision as of 21:40, 23 September 2013
| bool try_lock(); |
(since {std}) | |
Tries to lock the mutex. Returns immediately. On successful lock acquisition returns true, otherwise returns false.
This function is allowed to fail spuriously and return false even if the mutex is not currently locked by any other thread.
| Templated information. See page source. |
Prior unlock() operation on the same mutex synchronizes-with (as defined in std::memory_order) this operation if it returns true. Note that prior lock() does not synchronize with this operation if it returns false.
Contents |
Parameters
(none)
Return value
true if the lock was acquired successfully, otherwise false.
Exceptions
(none)
Example
| Templated content. The link is cpp/thread/<PP>/example_try_lock |
See also
| locks the mutex, blocks if the mutex is not available (public member function of std::{{{1}}})
| |
| unlocks the mutex (public member function of std::{{{1}}})
|
