Allows threads to wait for events triggered by other threads. More...
|WaitableEvent (bool manualReset=false) noexcept|
|Creates a WaitableEvent object. More...|
|~WaitableEvent () noexcept|
|bool||wait (int timeOutMilliseconds=-1) const noexcept|
|Suspends the calling thread until the event has been signalled. More...|
|void||signal () const noexcept|
|Wakes up any threads that are currently waiting on this object. More...|
|void||reset () const noexcept|
|Resets the event to an unsignalled state. More...|
Allows threads to wait for events triggered by other threads.
Constructor & Destructor Documentation
Creates a WaitableEvent object.
The object is initially in an unsignalled state.
If other threads are waiting on this object when it gets deleted, this can cause nasty errors, so be careful!
Member Function Documentation
Suspends the calling thread until the event has been signalled.
This will wait until the object's signal() method is called by another thread, or until the timeout expires.
After the event has been signalled, this method will return true and if manualReset was set to false in the WaitableEvent's constructor, then the event will be reset.
timeOutMilliseconds the maximum time to wait, in milliseconds. A negative value will cause it to wait forever.
- true if the object has been signalled, false if the timeout expires first.
Wakes up any threads that are currently waiting on this object.
If the WaitableEvent is automatic reset, and one or more threads is waiting upon the object, then one of them will be woken up. If no threads are currently waiting, then the next thread to call wait() will be woken up. As soon as a thread is woken, the signal is automatically reset.
Resets the event to an unsignalled state.
If it's not already signalled, this does nothing.
The documentation for this class was generated from the following file:
Generated on Fri Jan 12 2018 09:51:24 for JUCE by 1.8.13