std::shared_lock<Mutex>::try_lock_until (3) - Linux Man Pages

std::shared_lock<Mutex>::try_lock_until: std::shared_lock<Mutex>::try_lock_until

NAME

std::shared_lock<Mutex>::try_lock_until - std::shared_lock<Mutex>::try_lock_until

Synopsis


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


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.

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

Example


 This section is incomplete
 Reason: no example

See also


               locks the associated mutex
lock (public member function)
               tries to lock the associated mutex
try_lock (public member function)
               tries to lock the associated mutex, for the specified duration
try_lock_for (public member function)
               unlocks the associated mutex
unlock (public member function)
               tries to lock the associated TimedLockable mutex, returns if the mutex has been unavailable until specified time point has been reached
try_lock_until (public member function of std::unique_lock<Mutex>)