mirror of
https://github.com/pocoproject/poco.git
synced 2024-12-16 03:42:53 +01:00
136 lines
2.6 KiB
C++
136 lines
2.6 KiB
C++
//
|
|
// Event.h
|
|
//
|
|
// $Id: //poco/1.4/Foundation/include/Poco/Event.h#2 $
|
|
//
|
|
// Library: Foundation
|
|
// Package: Threading
|
|
// Module: Event
|
|
//
|
|
// Definition of the Event class.
|
|
//
|
|
// Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
|
|
// and Contributors.
|
|
//
|
|
// SPDX-License-Identifier: BSL-1.0
|
|
//
|
|
|
|
|
|
#ifndef Foundation_Event_INCLUDED
|
|
#define Foundation_Event_INCLUDED
|
|
|
|
|
|
#include "Poco/Foundation.h"
|
|
#include "Poco/Exception.h"
|
|
|
|
|
|
#if defined(POCO_OS_FAMILY_WINDOWS)
|
|
#include "Poco/Event_WIN32.h"
|
|
#elif defined(POCO_VXWORKS)
|
|
#include "Poco/Event_VX.h"
|
|
#else
|
|
#include "Poco/Event_POSIX.h"
|
|
#endif
|
|
|
|
|
|
namespace Poco {
|
|
|
|
|
|
class Foundation_API Event: private EventImpl
|
|
/// An Event is a synchronization object that
|
|
/// allows one thread to signal one or more
|
|
/// other threads that a certain event
|
|
/// has happened.
|
|
/// Usually, one thread signals an event,
|
|
/// while one or more other threads wait
|
|
/// for an event to become signalled.
|
|
{
|
|
public:
|
|
enum EventType
|
|
{
|
|
EVENT_MANUALRESET = EVENT_MANUALRESET_IMPL, /// Manual reset event
|
|
EVENT_AUTORESET = EVENT_AUTORESET_IMPL /// Auto-reset event
|
|
};
|
|
|
|
explicit Event(EventType type = EVENT_AUTORESET);
|
|
/// Creates the event. If type is EVENT_AUTORESET,
|
|
/// the event is automatically reset after
|
|
/// a wait() successfully returns.
|
|
|
|
//@ deprecated
|
|
explicit Event(bool autoReset);
|
|
/// Please use Event::Event(EventType) instead.
|
|
|
|
~Event();
|
|
/// Destroys the event.
|
|
|
|
void set();
|
|
/// Signals the event. If autoReset is true,
|
|
/// only one thread waiting for the event
|
|
/// can resume execution.
|
|
/// If autoReset is false, all waiting threads
|
|
/// can resume execution.
|
|
|
|
void wait();
|
|
/// Waits for the event to become signalled.
|
|
|
|
void wait(long milliseconds);
|
|
/// Waits for the event to become signalled.
|
|
/// Throws a TimeoutException if the event
|
|
/// does not become signalled within the specified
|
|
/// time interval.
|
|
|
|
bool tryWait(long milliseconds);
|
|
/// Waits for the event to become signalled.
|
|
/// Returns true if the event
|
|
/// became signalled within the specified
|
|
/// time interval, false otherwise.
|
|
|
|
void reset();
|
|
/// Resets the event to unsignalled state.
|
|
|
|
private:
|
|
Event(const Event&);
|
|
Event& operator = (const Event&);
|
|
};
|
|
|
|
|
|
//
|
|
// inlines
|
|
//
|
|
inline void Event::set()
|
|
{
|
|
setImpl();
|
|
}
|
|
|
|
|
|
inline void Event::wait()
|
|
{
|
|
waitImpl();
|
|
}
|
|
|
|
|
|
inline void Event::wait(long milliseconds)
|
|
{
|
|
if (!waitImpl(milliseconds))
|
|
throw TimeoutException();
|
|
}
|
|
|
|
|
|
inline bool Event::tryWait(long milliseconds)
|
|
{
|
|
return waitImpl(milliseconds);
|
|
}
|
|
|
|
|
|
inline void Event::reset()
|
|
{
|
|
resetImpl();
|
|
}
|
|
|
|
|
|
} // namespace Poco
|
|
|
|
|
|
#endif // Foundation_Event_INCLUDED
|