std::condition_variable_any (3) - Linux Manuals

std::condition_variable_any: std::condition_variable_any

NAME

std::condition_variable_any - std::condition_variable_any

Synopsis

Defined in header <condition_variable>
class condition_variable_any; (since C++11)

The condition_variable_any class is a generalization of std::condition_variable. Whereas std::condition_variable works only on std::unique_lock<std::mutex>, condition_variable_any can operate on any lock that meets the BasicLockable requirements.
See std::condition_variable for the description of the semantics of condition variables.
The class std::condition_variable_any is a StandardLayoutType. It is not CopyConstructible, MoveConstructible, CopyAssignable, or MoveAssignable.
If the lock is std::unique_lock, std::condition_variable may provide better performance.

Member functions

              constructs the object
constructor (public member function)
              destructs the object
destructor (public member function)

operator= not copy-assignable
              (public member function)
[deleted]

Notification

              notifies one waiting thread
notify_one (public member function)
              notifies all waiting threads
notify_all (public member function)

Waiting

              blocks the current thread until the condition variable is woken up
wait (public member function)
              blocks the current thread until the condition variable is woken up or after the specified timeout duration
wait_for (public member function)
              blocks the current thread until the condition variable is woken up or until specified time point has been reached
wait_until (public member function)

Notes

std::condition_variable_any can be used with std::shared_lock in order to wait on a std::shared_mutex in shared ownership mode.
A possible use for std::condition_variable_any with custom Lockable types is to provide convenient interruptible waits: the custom lock operation would both lock the associated mutex as expected, and also perform the necessary setup to notify this condition variable when the interrupting signal is received.[1]

References

  1. ↑ A. Williams (2012), "C++ concurrency in action" 9.2.4 Interrupting a wait on std::condition_variable_any