mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-28 02:30:05 +00:00
109 lines
4.3 KiB
C++
109 lines
4.3 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE library - "Jules' Utility Class Extensions"
|
|
Copyright 2004-11 by Raw Material Software Ltd.
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
JUCE can be redistributed and/or modified under the terms of the GNU General
|
|
Public License (Version 2), as published by the Free Software Foundation.
|
|
A copy of the license is included in the JUCE distribution, or can be found
|
|
online at www.gnu.org/licenses.
|
|
|
|
JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
|
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
|
|
------------------------------------------------------------------------------
|
|
|
|
To release a closed-source product which uses JUCE, commercial licenses are
|
|
available: visit www.rawmaterialsoftware.com/juce for more information.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
#ifndef __JUCE_WAITABLEEVENT_JUCEHEADER__
|
|
#define __JUCE_WAITABLEEVENT_JUCEHEADER__
|
|
|
|
#include "../text/juce_String.h"
|
|
|
|
|
|
//==============================================================================
|
|
/**
|
|
Allows threads to wait for events triggered by other threads.
|
|
|
|
A thread can call wait() on a WaitableObject, and this will suspend the
|
|
calling thread until another thread wakes it up by calling the signal()
|
|
method.
|
|
*/
|
|
class JUCE_API WaitableEvent
|
|
{
|
|
public:
|
|
//==============================================================================
|
|
/** Creates a WaitableEvent object.
|
|
|
|
@param manualReset If this is false, the event will be reset automatically when the wait()
|
|
method is called. If manualReset is true, then once the event is signalled,
|
|
the only way to reset it will be by calling the reset() method.
|
|
*/
|
|
WaitableEvent (bool manualReset = false) noexcept;
|
|
|
|
/** Destructor.
|
|
|
|
If other threads are waiting on this object when it gets deleted, this
|
|
can cause nasty errors, so be careful!
|
|
*/
|
|
~WaitableEvent() noexcept;
|
|
|
|
//==============================================================================
|
|
/** 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.
|
|
|
|
@param timeOutMilliseconds the maximum time to wait, in milliseconds. A negative
|
|
value will cause it to wait forever.
|
|
|
|
@returns true if the object has been signalled, false if the timeout expires first.
|
|
@see signal, reset
|
|
*/
|
|
bool wait (int timeOutMilliseconds = -1) const noexcept;
|
|
|
|
//==============================================================================
|
|
/** Wakes up any threads that are currently waiting on this object.
|
|
|
|
If signal() is called when nothing is waiting, the next thread to call wait()
|
|
will return immediately and reset the signal.
|
|
|
|
If the WaitableEvent is manual reset, all threads that are currently waiting on this
|
|
object will be woken.
|
|
|
|
If the WaitableEvent is automatic reset, and there are one or more threads waiting
|
|
on 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.
|
|
|
|
@see wait, reset
|
|
*/
|
|
void signal() const noexcept;
|
|
|
|
//==============================================================================
|
|
/** Resets the event to an unsignalled state.
|
|
|
|
If it's not already signalled, this does nothing.
|
|
*/
|
|
void reset() const noexcept;
|
|
|
|
|
|
private:
|
|
//==============================================================================
|
|
void* internal;
|
|
|
|
JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (WaitableEvent);
|
|
};
|
|
|
|
|
|
#endif // __JUCE_WAITABLEEVENT_JUCEHEADER__
|