OSSignalEvent

Syntax

#include <cafe/os.h>

void OSSignalEvent(OSEvent* event);

Parameters

event OSEvent to signal.

Return Values

None.

Description

If the OSEvent is in Manual Mode, OSSignalEvent will signal the specified OSEvent and wake up all waiting threads. The signaled OSEvent will maintain its state until OSResetEvent is called.

If the OSEvent is in Auto Mode, of waiting threads for the specified OSEvent, OSSignalEvent will wake up the one with highest priority. At this time, the state of OSEvent after OSSignalEvent will be automatically reset and become non-signaled. If there is no waiting thread for the specified OSEvent, the OSEvent will become signaled. To wake up all waiting threads in Auto Mode, use OSSignalEventAll.

Do Not Call From

None.

See Also

OSInitEvent
OSSignalEventAll
OSWaitEvent
OSWaitEventWithTimeout
OSResetEvent

Revision History

2013/05/08 Automated cleanup pass.
2012/08/01 Cleanup pass.
2011/03/02 Added the description of mode.
2010/12/15 Initial version.


CONFIDENTIAL