SysTutorials

Linux Manual Pages › Section 3

stdshared_locktry_lock_for(3)

std::shared_lock<Mutex>::try_lock_for - std::shared_lock<Mutex>::try_lock_for

Synopsis

template <class Rep, class Period>
(since C++ 14)
    bool try_lock_for(const std::chrono::duration<Rep, Period> &timeout_duration);

Tries to lock the associated mutex in shared mode. Blocks until specified timeout_duration has elapsed or the lock is acquired, whichever comes first. On successful lock acquisition returns true, otherwise returns false. Effectively calls mutex()->try_lock_shared_for(timeout_duration). This function may block for longer than timeout_duration due to scheduling or resource contention delays. The standard recommends that a steady clock is used to measure the duration. If an implementation uses a system clock instead, the wait time may also be sensitive to clock adjustments. std::system_error is thrown if there is no associated mutex or if the mutex is already locked.

Parameters

timeout_duration - maximum duration to block for

Return value

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

Exceptions

Example

 This section is incomplete  Reason: no example

See also

               attempts to lock the associated TimedLockable mutex, returns if the mutex has been unavailable for the specified time duration try_lock_for (public member function of std::unique_lock<Mutex>)                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, until a specified time point try_lock_until (public member function)                unlocks the associated mutex unlock (public member function)