Events


Functions

void os_event_init (os_event_t *evt)
void os_event_destroy (os_event_t *evt)
uint16_t os_event_wait (os_event_t *evt)
uint16_t os_event_wait_interruptible (os_event_t *evt) uint16_t os_event_wait_timed(os_event_t *evt
void os_event_raise (os_event_t *evt, uint16_t events)

Function Documentation

void os_event_destroy ( os_event_t *  evt  ) 

Destroy an event.

Destroy an event previously initialized with os_event_init(), freeing any associated resources.

Callable from: thread context.

Parameters:
evt event to destroy

void os_event_init ( os_event_t *  evt  ) 

Initialize an event.

Callable from: thread context.

Parameters:
evt event to initialize.

void os_event_raise ( os_event_t *  evt,
uint16_t  events 
)

Raise an event, waking the thread waiting in os_event_wait().

Callable from: thread context.

Parameters:
evt event to wait for.
events the set of events to raise.

uint16_t os_event_wait ( os_event_t *  evt  ) 

Wait for an event to be raised.

Callable from: thread context.

Parameters:
evt event to wait for.
Returns:
the set of events raised since the last call to os_event_wait().

uint16_t os_event_wait_interruptible ( os_event_t *  evt  ) 

Wait for an event to be raised.

The wait may be interrupted by a signal or other OS-specific asynchronous event.

Callable from: thread context.

Parameters:
evt event to wait for.
Returns:
the set of events raised since the last call to os_event_wait(). Wait (with a timeout) for an event to be raised.
Only one thread should wait on a particular event.

Callable from: thread context.

Parameters:
evt event to wait for.
timeout_ms time to wait for an event (in milliseconds).
Returns:
the set of events raised since the last call to os_event_wait().

0 if no event was raised before the timeout expired.


Generated on Wed Oct 27 15:14:03 2010 for oska by  doxygen 1.5.5