std::shared_mutex::try_lock_shared

From cppreference.com
< cpp‎ | thread‎ | shared mutex
 
 
Thread support library
Threads
(C++11)
this_thread namespace
(C++11)
(C++11)
(C++11)
(C++11)
Mutual exclusion
(C++11)
(C++11)
(C++17)
Generic lock management
(C++11)
(C++11)
(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)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
 
 
bool try_lock_shared();
(since C++17)

Tries to lock the mutex in shared mode. 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 currenly exclusively locked by any other thread.

Prior unlock() operation on the same mutex synchronizes-with (as defined in std::memory_order) this operation if it returns true.

The behavior is undefined if the calling thread already owns the mutex in any mode.

Contents

[edit] Parameters

(none)

[edit] Return value

true if the lock was acquired successfully, otherwise false.

[edit] Exceptions

(none)

[edit] Example

[edit] See also

locks the mutex, blocks if the mutex is not available
(public member function)
try_lock_shared
tries to lock the mutex for shared ownership, returns if the mutex is not available
(public member function)
unlocks the mutex (shared ownership)
(public member function)