[thread.condvarany.wait] (original) (raw)
32 Concurrency support library [thread]
32.7 Condition variables [thread.condition]
32.7.5 Class condition_variable_any [thread.condition.condvarany]
32.7.5.2 Noninterruptible waits [thread.condvarany.wait]
template<class Lock> void wait(Lock& lock);
Effects:
- Atomically calls lock.unlock() and blocks on *this.
- When unblocked, calls lock.lock() (possibly blocking on the lock) and returns.
- The function will unblock when signaled by a call to notify_one(), a call to notify_all(), or spuriously.
Postconditions: lock is locked by the calling thread.
Remarks: If the function fails to meet the postcondition, terminate()is invoked ([except.terminate]).
[Note 1:
This can happen if the re-locking of the mutex throws an exception.
— _end note_]
template<class Lock, class Predicate> void wait(Lock& lock, Predicate pred);
Effects: Equivalent to:while (!pred()) wait(lock);
template<class Lock, class Clock, class Duration> cv_status wait_until(Lock& lock, const chrono::time_point<Clock, Duration>& abs_time);
Effects:
- Atomically calls lock.unlock() and blocks on *this.
- When unblocked, calls lock.lock() (possibly blocking on the lock) and returns.
- The function will unblock when signaled by a call to notify_one(), a call to notify_all(), expiration of the absolute timeout ([thread.req.timing]) specified by abs_time, or spuriously.
- If the function exits via an exception, lock.lock() is called prior to exiting the function.
Postconditions: lock is locked by the calling thread.
Returns: cv_status::timeout if the absolute timeout ([thread.req.timing]) specified by abs_time expired, otherwise cv_status::no_timeout.
Remarks: If the function fails to meet the postcondition, terminate()is invoked ([except.terminate]).
[Note 2:
This can happen if the re-locking of the mutex throws an exception.
— _end note_]
template<class Lock, class Rep, class Period> cv_status wait_for(Lock& lock, const chrono::duration<Rep, Period>& rel_time);
Effects: Equivalent to:return wait_until(lock, chrono::steady_clock::now() + rel_time);
Postconditions: lock is locked by the calling thread.
Returns: cv_status::timeout if the relative timeout ([thread.req.timing]) specified by rel_time expired, otherwise cv_status::no_timeout.
Remarks: If the function fails to meet the postcondition, terminateis invoked ([except.terminate]).
[Note 3:
This can happen if the re-locking of the mutex throws an exception.
— _end note_]
template<class Lock, class Clock, class Duration, class Predicate> bool wait_until(Lock& lock, const chrono::time_point<Clock, Duration>& abs_time, Predicate pred);
Effects: Equivalent to:while (!pred()) if (wait_until(lock, abs_time) == cv_status::timeout) return pred();return true;
[Note 4:
There is no blocking if pred() is initially true, or if the timeout has already expired.
— _end note_]
[Note 5:
The returned value indicates whether the predicate evaluates to trueregardless of whether the timeout was triggered.
— _end note_]
template<class Lock, class Rep, class Period, class Predicate> bool wait_for(Lock& lock, const chrono::duration<Rep, Period>& rel_time, Predicate pred);
Effects: Equivalent to:return wait_until(lock, chrono::steady_clock::now() + rel_time, std::move(pred));