std::timed_mutex::try_lock_until

 

C++

Language

Standard library headers

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::timed_mutex

Member functions

timed_mutex::timed_mutex

Locking

timed_mutex::lock

timed_mutex::try_lock

timed_mutex::try_lock_for

timed_mutex::try_lock_until

timed_mutex::unlock

Native handle

timed_mutex::native_handle

 

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 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.

The clock tied to timeout_time is used, which means that adjustments of the clock are taken into account. Thus, the maximum duration of the block might, but might not, be less or more than timeout_time - Clock::now() at the time of the call, depending on the direction of the adjustment. The function also may block for longer than until after timeout_time has been reached due to scheduling or resource contention delays.

The behavior is undefined if the mutex is not unlocked before being destroyed, i.e. some thread still owns it.

Parameters

timeout_time

-

maximum time point to block until

Return value

true if the lock was acquired successfully, otherwise false.

Exceptions

(none)

Example

This example shows a two minute block

run this code

#include <iostream>
#include <ctime>
#include <chrono>
#include <mutex>
 
int main()
{
    std::timed_mutex test;
    test.try_lock();
    auto now=std::chrono::steady_clock::now();
    test.try_lock_until(now+std::chrono::minutes(2));
    std::cout << "hello world";
 
}

See also

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