Library: Foundation
Package: Threading
Header: Poco/Event.h
Description
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.
Inheritance
Direct Base Classes: EventImpl
All Base Classes: EventImpl
Member Summary
Member Functions: reset, set, tryWait, wait
Enumerations
EventType
Manual reset event
Auto-reset event
Constructors
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.
Event
explicit Event(
bool autoReset
);
Deprecated. This function is deprecated and should no longer be used.
Please use Event::Event(EventType) instead.
Destructor
~Event
~Event();
Destroys the event.
Member Functions
reset 
void reset();
Resets the event to unsignalled state.
set
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.
tryWait
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.
wait
void wait();
Waits for the event to become signalled.
wait
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.