std::unique_lock::try_lock_for

From cppreference.com
< cpp‎ | thread‎ | unique lock
 
 
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)
 
 
template< class Rep, class Period >
bool try_lock_for( const std::chrono::duration<Rep,Period>& timeout_duration );
(since C++11)

Tries to lock the associated mutex. Blocks until specified timeout_duration has elapsed or the lock is acquired, whichever comes first. On successful lock acquisition returns true, otherwise returns false. Effectively calls mutex()->try_lock_for(timeout_duration).

A steady clock is used to measure the duration. This function may block for longer than timeout_duration due to scheduling or resource contention delays.

std::system_error is thrown if there is no associated mutex or if the mutex is already locked.

Contents

[edit] Parameters

timeout_duration - maximum duration to block for

[edit] Return value

true if the ownership of the mutex has been acquired successfully, false otherwise.

[edit] Exceptions

  • Any exceptions thrown by mutex()->try_lock_for(timeout_duration)

[edit] Example

[edit] See also

locks the associated mutex
(public member function)
tries to lock the associated mutex, returns if the mutex is not available
(public member function)
tries to lock the associated TimedLockable mutex, returns if the mutex has been unavailable until specified time point has been reached
(public member function)
unlocks the associated mutex
(public member function)