30 Thread support library [thread]

30.5 Condition variables [thread.condition]

30.5.4 Class condition_­variable_­any [thread.condition.condvarany]

1
#
A Lock type shall satisfy the Cpp17BasicLockable requirements ([thread.req.lockable.basic]).
[ Note
:
All of the standard mutex types meet this requirement.
If a Lock type other than one of the standard mutex types or a unique_­lock wrapper for a standard mutex type is used with condition_­variable_­any, the user should ensure that any necessary synchronization is in place with respect to the predicate associated with the condition_­variable_­any instance.
— end note
 ]
namespace std {
  class condition_variable_any {
  public:
    condition_variable_any();
    ~condition_variable_any();

    condition_variable_any(const condition_variable_any&) = delete;
    condition_variable_any& operator=(const condition_variable_any&) = delete;

    void notify_one() noexcept;
    void notify_all() noexcept;
    template<class Lock>
      void wait(Lock& lock);
    template<class Lock, class Predicate>
      void wait(Lock& lock, Predicate pred);

    template<class Lock, class Clock, class Duration>
      cv_status wait_until(Lock& lock, const chrono::time_point<Clock, Duration>& abs_time);
    template<class Lock, class Clock, class Duration, class Predicate>
      bool wait_until(Lock& lock, const chrono::time_point<Clock, Duration>& abs_time,
                      Predicate pred);
    template<class Lock, class Rep, class Period>
      cv_status wait_for(Lock& lock, const chrono::duration<Rep, Period>& rel_time);
    template<class Lock, class Rep, class Period, class Predicate>
      bool wait_for(Lock& lock, const chrono::duration<Rep, Period>& rel_time, Predicate pred);
  };
}
🔗
condition_variable_any();
2
#
Effects: Constructs an object of type condition_­variable_­any.
3
#
Throws: bad_­alloc or system_­error when an exception is required ([thread.req.exception]).
4
#
Error conditions:
  • (4.1)
    resource_­unavailable_­try_­again — if some non-memory resource limitation prevents initialization.
  • (4.2)
    operation_­not_­permitted — if the thread does not have the privilege to perform the operation.
🔗
~condition_variable_any();
5
#
Requires: There shall be no thread blocked on *this.
[ Note
:
That is, all threads shall have been notified; they may subsequently block on the lock specified in the wait.
This relaxes the usual rules, which would have required all wait calls to happen before destruction.
Only the notification to unblock the wait needs to happen before destruction.
The user should take care to ensure that no threads wait on *this once the destructor has been started, especially when the waiting threads are calling the wait functions in a loop or using the overloads of wait, wait_­for, or wait_­until that take a predicate.
— end note
 ]
6
#
Effects: Destroys the object.
🔗
void notify_one() noexcept;
7
#
Effects: If any threads are blocked waiting for *this, unblocks one of those threads.
🔗
void notify_all() noexcept;
8
#
Effects: Unblocks all threads that are blocked waiting for *this.
🔗
template<class Lock> void wait(Lock& lock);
9
#
Effects:
  • (9.1)
    Atomically calls lock.unlock() and blocks on *this.
  • (9.2)
    When unblocked, calls lock.lock() (possibly blocking on the lock) and returns.
  • (9.3)
    The function will unblock when signaled by a call to notify_­one(), a call to notify_­all(), or spuriously.
10
#
Remarks: If the function fails to meet the postcondition, terminate() shall be called ([except.terminate]).
[ Note
:
This can happen if the re-locking of the mutex throws an exception.
— end note
 ]
11
#
Ensures: lock is locked by the calling thread.
12
#
Throws: Nothing.
🔗
template<class Lock, class Predicate> void wait(Lock& lock, Predicate pred);
13
#
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);
14
#
Effects:
  • (14.1)
    Atomically calls lock.unlock() and blocks on *this.
  • (14.2)
    When unblocked, calls lock.lock() (possibly blocking on the lock) and returns.
  • (14.3)
    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.
  • (14.4)
    If the function exits via an exception, lock.lock() shall be called prior to exiting the function.
15
#
Remarks: If the function fails to meet the postcondition, terminate() shall be called ([except.terminate]).
[ Note
:
This can happen if the re-locking of the mutex throws an exception.
— end note
 ]
16
#
Ensures: lock is locked by the calling thread.
17
#
Returns: cv_­status​::​timeout if the absolute timeout ([thread.req.timing]) specified by abs_­time expired, otherwise cv_­status​::​no_­timeout.
18
#
Throws: Timeout-related exceptions ([thread.req.timing]).
🔗
template<class Lock, class Rep, class Period> cv_status wait_for(Lock& lock, const chrono::duration<Rep, Period>& rel_time);
19
#
Effects: Equivalent to: 
return wait_until(lock, chrono::steady_clock::now() + rel_time);
20
#
Returns: cv_­status​::​timeout if the relative timeout ([thread.req.timing]) specified by rel_­time expired, otherwise cv_­status​::​no_­timeout.
21
#
Remarks: If the function fails to meet the postcondition, terminate() shall be called ([except.terminate]).
[ Note
:
This can happen if the re-locking of the mutex throws an exception.
— end note
 ]
22
#
Ensures: lock is locked by the calling thread.
23
#
Throws: Timeout-related exceptions ([thread.req.timing]).
🔗
template<class Lock, class Clock, class Duration, class Predicate> bool wait_until(Lock& lock, const chrono::time_point<Clock, Duration>& abs_time, Predicate pred);
24
#
Effects: Equivalent to: 
while (!pred())
  if (wait_until(lock, abs_time) == cv_status::timeout)
    return pred();
return true;
25
#
[ Note
:
There is no blocking if pred() is initially true, or if the timeout has already expired.
— end note
 ]
26
#
[ Note
:
The returned value indicates whether the predicate evaluates to true regardless 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);
27
#
Effects: Equivalent to: 
return wait_until(lock, chrono::steady_clock::now() + rel_time, std::move(pred));