Namespaces
Variants
Views
Actions

std::shared_lock<Mutex>::try_lock_until

From cppreference.com
< cpp‎ | thread‎ | shared lock
 
 
Concurrency support library
Threads
(C++11)
(C++20)
(C++20)
this_thread namespace
(C++11)
(C++11)
(C++11)
Mutual exclusion
(C++11)
(C++11)  
Generic lock management
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
Condition variables
(C++11)
Semaphores
Latches and Barriers
(C++20)
(C++20)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
Safe Reclamation
(C++26)
(C++26)
Hazard Pointers

Atomic types
(C++11)
(C++20)
Initialization of atomic types
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
Memory ordering
Free functions for atomic operations
Free functions for atomic flags
 
 
template< class Clock, class Duration >
bool try_lock_until( const std::chrono::time_point<Clock,Duration>& timeout_time );
(since C++14)

Tries to lock the associated mutex in shared mode. 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_shared_until(timeout_time).

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

Clock must meet the Clock requirements. The behavior is undefined if Mutex does not meet the SharedTimedLockable requirements. The program is ill-formed if std::chrono::is_clock_v<Clock> is false.(since C++20)

Contents

[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_shared_for(timeout_time).

[edit] Example

[edit] See also

locks the associated mutex
(public member function) [edit]
tries to lock the associated mutex
(public member function) [edit]
tries to lock the associated mutex, for the specified duration
(public member function) [edit]
unlocks the associated mutex
(public member function) [edit]
tries to lock (i.e., takes ownership of) the associated TimedLockable mutex, returns if the mutex has been unavailable until specified time point has been reached
(public member function of std::unique_lock<Mutex>) [edit]