Abstract base class for condition variable implementations. More...
#include <condition.h>
Inheritance diagram for original::conditionBase:
Collaboration diagram for original::conditionBase:
Public Member Functions | |
| conditionBase ()=default | |
| Default constructor. | |
| virtual void | wait (mutexBase &mutex)=0 |
| Waits for notification while holding the mutex. | |
| virtual bool | waitFor (mutexBase &mutex, time::duration d)=0 |
| Waits for notification with timeout. | |
| template<typename Pred > | |
| void | wait (mutexBase &mutex, Pred predicate) noexcept(noexcept(predicate())) |
| Waits until predicate becomes true. | |
| template<typename Pred > | |
| bool | waitFor (mutexBase &mutex, const time::duration &d, Pred predicate) noexcept(noexcept(predicate())) |
| Waits with timeout until predicate becomes true. | |
| virtual void | notify ()=0 |
| Notifies one waiting thread. | |
| virtual void | notifyAll ()=0 |
| Notifies all waiting threads. | |
| void | notifySome (u_integer n) |
| Notifies a specified number of waiting threads. | |
| virtual | ~conditionBase ()=default |
| Virtual destructor. | |
| conditionBase (const conditionBase &)=delete | |
| Deleted copy constructor. | |
| conditionBase & | operator= (const conditionBase &)=delete |
| Deleted copy assignment operator. | |
Detailed Description
Abstract base class for condition variable implementations.
Provides the interface for thread synchronization operations:
- Waiting with mutex protection
- Timed waiting with duration support
- Notification of waiting threads
- Predicate-based waiting templates
- Note
- This is an abstract base class and cannot be instantiated directly. Derived classes must implement all pure virtual methods.
Member Function Documentation
◆ notify()
Notifies one waiting thread.
- Exceptions
-
sysError if notification fails
Implemented in original::condition.
◆ notifyAll()
Notifies all waiting threads.
- Exceptions
-
sysError if notification fails
Implemented in original::condition.
◆ notifySome()
Notifies a specified number of waiting threads.
- Parameters
-
n Number of threads to notify
This method provides a flexible notification mechanism:
- If n == 0: No operation is performed
- If n == 1: Equivalent to calling notify()
- If n >= 2: Equivalent to calling notifyAll()
- Note
- This is a convenience method for scenarios where the exact number of threads to notify depends on runtime conditions. For precise control over thread notification, use notify() or notifyAll() directly.
◆ wait() [1/2]
Waits for notification while holding the mutex.
- Parameters
-
mutex Locked mutex to wait on
- Exceptions
-
sysError if wait operation fails
- Note
- The mutex must be locked by the calling thread
Implemented in original::condition, and original::condition.
◆ wait() [2/2]
Waits until predicate becomes true.
- Template Parameters
-
Pred Predicate type (must be callable and return bool)
- Parameters
-
mutex Locked mutex to wait on predicate Condition predicate to check
- Exceptions
-
sysError if wait operation fails
- Note
- Implements the "wait with predicate" pattern to avoid spurious wakeups
◆ waitFor() [1/2]
|
noexcept |
Waits with timeout until predicate becomes true.
- Template Parameters
-
Pred Predicate type (must be callable and return bool)
- Parameters
-
mutex Locked mutex to wait on d Maximum duration to wait predicate Condition predicate to check
- Returns
- true if predicate became true, false if timeout occurred
- Exceptions
-
sysError if wait operation fails
◆ waitFor() [2/2]
|
pure virtual |
Waits for notification with timeout.
- Parameters
-
mutex Locked mutex to wait on d Maximum duration to wait
- Returns
- true if notified, false if timeout occurred
- Exceptions
-
sysError if wait operation fails
- Note
- The mutex must be locked by the calling thread
Implemented in original::condition, and original::condition.
The documentation for this class was generated from the following file:
- src/vibrant/condition.h
