UCommon
|
Event notification to manage scheduled realtime threads. More...
#include <thread.h>
Public Member Functions | |
void | reset (void) |
Reset triggered conditional. | |
void | signal (void) |
Signal pending event. | |
TimedEvent (void) | |
Create event handler and timer for timing of events. | |
TimedEvent (timeout_t timeout) | |
Create event handler and timer set to trigger a timeout. | |
TimedEvent (time_t timeout) | |
Create event handler and timer set to trigger a timeout. | |
bool | wait (timeout_t timeout) |
Wait to be signalled or until timer expires. | |
void | wait (void) |
A simple wait until triggered. | |
~TimedEvent () | |
Destroy timer and release pending events. | |
Static Public Member Functions | |
static void | reset (TimedEvent &timed) |
Event function to reset timer for external type. | |
static void | signal (TimedEvent &timed) |
Event function for external type. | |
static bool | wait (TimedEvent &timed, timeout_t timeout) |
Event function for external type for waiting. | |
Protected Member Functions | |
void | lock (void) |
Lock the object for wait or to manipulate derived data. | |
void | release (void) |
Release the object lock after waiting. | |
bool | sync (void) |
Wait while locked. |
Event notification to manage scheduled realtime threads.
The timer is advanced to sleep threads which then wakeup either when the timer has expired or they are notified through the signal handler. This can be used to schedule and signal one-time completion handlers or for time synchronized events signaled by an asychrononous I/O or event source.
ucommon::TimedEvent::TimedEvent | ( | timeout_t | timeout | ) |
Create event handler and timer set to trigger a timeout.
timeout | in milliseconds. |
ucommon::TimedEvent::TimedEvent | ( | time_t | timeout | ) |
Create event handler and timer set to trigger a timeout.
timeout | in seconds. |
void ucommon::TimedEvent::lock | ( | void | ) | [protected] |
Lock the object for wait or to manipulate derived data.
This is relevant to manipulations in a derived class.
void ucommon::TimedEvent::release | ( | void | ) | [protected] |
Release the object lock after waiting.
This is relevent to manipulations in a derived class.
static void ucommon::TimedEvent::reset | ( | TimedEvent & | timed | ) | [inline, static] |
void ucommon::TimedEvent::signal | ( | void | ) |
Signal pending event.
Object may be locked or unlocked. The signalling thread may choose to lock and check a condition in a derived class before signalling.
static void ucommon::TimedEvent::signal | ( | TimedEvent & | timed | ) | [inline, static] |
bool ucommon::TimedEvent::sync | ( | void | ) | [protected] |
Wait while locked.
This can be used in more complex derived objects where we are concerned with synchronized access between the signaling and event thread. This can be used in place of wait, but lock and release methods must be used around it.
bool ucommon::TimedEvent::wait | ( | timeout_t | timeout | ) |
Wait to be signalled or until timer expires.
This is a wrapper for expire for simple completion events.
timeout | to wait from last reset. |
static bool ucommon::TimedEvent::wait | ( | TimedEvent & | timed, |
timeout_t | timeout | ||
) | [inline, static] |