OS_SignalEvent

Syntax

#include <nitro/os.h>
void OS_SignalEvent(
     OSEvent*   event,
     u32        setPattern );
  

Arguments

event Pointer to an event structure.
setPattern Bit pattern of the event flag to set.

Return Values

None.

Description

Generates an event and signals threads waiting for an event.

event is a pointer to an event structure. This function sets the bits expressed by setPattern in the event flag member of this structure. As a result, execution rights may be transferred to a thread that is waiting for an event.

Internally, after the event flag is changed, all threads registered in event that are waiting for events will be changed from the waiting state to the runnable state by OS_WakeupThread(). If the individual threads meet the completion conditions, they will enter the runnable state right away, but if they don't meet the completion conditions, they'll reenter the waiting state using OS_SleepThread().

See Also

OS_InitEvent, OS_WaitEvent*, OS_Clear*Event, OS_PollEvent*, OS Overview (Events)

Revision History

2007/12/04 Initial version.


CONFIDENTIAL