std::unique_lock<Mutex>::try_lock_until
From cppreference.com
< cpp | thread | unique lock
C++
Feature test macros (C++20)
Concepts library (C++20)
Metaprogramming library (C++11)
Ranges library (C++20)
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Concurrency support library
(C++11)
(C++20)
(C++11)
(C++11)
(C++20)
(C++26)
(C++26)
(C++20)
(C++26)
(C++20)
(C++26)
(C++26)
(C++26)
(C++26)
(C++26)
(C++26)
(C++11)
(C++11)
(C++17)
(C++11)
(C++14)
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)(C++11)(C++11)(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++20)(C++20)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++26)
(C++26)
(C++26)
(C++11)
(C++20)
(C++11)
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
(C++11)
(C++11)
(C++11)(deprecated in C++26)
(C++11)
(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++26)(C++26)
(C++26)(C++26)
(C++11)
(C++20)(C++20)
(C++20)
(C++20)
(C++11)(C++11)
(C++11)(C++11)
(C++20)(C++20)
(C++20)(C++20)
(C++20)
(C++20)
std::unique_lock
Member functions
Locking
unique_lock::try_lock_until
Modifiers
Observers
Non-member functions
template< class Clock, class Duration >
bool try_lock_until( const std::chrono::time_point <Clock, Duration>& timeout_time );
(since C++11)
bool try_lock_until( const std::chrono::time_point <Clock, Duration>& timeout_time );
Tries to lock (i.e., takes ownership of) the associated mutex. Blocks until specified timeout_time has been reached or the lock is acquired, whichever comes first. On successful lock acquisition returns true, otherwise returns false. May block for longer than timeout_time until has been reached.
Effectively calls mutex()->try_lock_until(timeout_time).
std::system_error is thrown if there is no associated mutex or if the mutex is already locked by the same thread.
Clock
must meet the Clock requirements. The program is ill-formed if std::chrono::is_clock_v <Clock> is false.(since C++20)
[edit] Parameters
timeout_time
-
maximum time point to block until
[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_until(timeout_time).
- If there is no associated mutex, std::system_error with an error code of std::errc::operation_not_permitted .
- If the mutex is already locked, std::system_error with an error code of std::errc::resource_deadlock_would_occur .
[edit] Example
This section is incomplete
Reason: no example
Reason: no example
[edit] See also
tries to lock (i.e., takes ownership of) the associated mutex without blocking
(public member function) [edit]
(public member function) [edit]
attempts to lock (i.e., takes ownership of) the associated TimedLockable mutex, returns if the mutex has been unavailable for the specified time duration
(public member function) [edit]
(public member function) [edit]