std::unique_lock::try_lock_until

 

C++

Language

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

 

Thread support library

Threads
thread (C++11)
this_thread namespace
get_id (C++11) yield (C++11)	sleep_for (C++11) sleep_until (C++11)
Mutual exclusion
mutex (C++11) timed_mutex (C++11)	recursive_mutex (C++11) recursive_timed_mutex (C++11)
Generic lock management
lock_guard (C++11) unique_lock (C++11) defer_lock_t try_to_lock_t adopt_lock_t (C++11) (C++11) (C++11)	lock (C++11) try_lock (C++11) defer_lock try_to_lock adopt_lock (C++11) (C++11) (C++11)
Condition variables
condition_variable (C++11)
condition_variable_any (C++11)
notify_all_at_thread_exit (C++11)
cv_status (C++11)
Futures
promise (C++11) future (C++11) shared_future (C++11) packaged_task (C++11) async (C++11)	launch (C++11) future_status (C++11) future_error (C++11) future_category (C++11) future_errc (C++11)

 

std::unique_lock

Member functions

unique_lock::unique_lock

unique_lock::~unique_lock

unique_lock::operator=

Locking

unique_lock::lock

unique_lock::try_lock

unique_lock::try_lock_for

unique_lock::try_lock_until

unique_lock::unlock

Modifiers

unique_lock::swap

unique_lock::release

Observers

unique_lock::mutex

unique_lock::owns_lock

unique_lock::operator bool

Non-member functions

std::swap

 

template< class Clock, class Duration > bool try_lock_until( const std::chrono::time_point<Clock,Duration>& timeout_time );		(since C++11)

Tries to lock 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 until timeout_time 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.

Parameters

timeout_time

-

maximum time point to block until

Return value

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

Exceptions

• Any exceptions thrown by mutex()->try_lock_for(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

See also

lock	locks the associated mutex (public member function)
try_lock	tries to lock the associated mutex, returns if the mutex is not available (public member function)
try_lock_for	attempts to lock the associated TimedLockable mutex, returns if the mutex has been unavailable for the specified time duration (public member function)
unlock	unlocks the associated mutex (public member function)