OSYieldThread

Syntax

#include <cafe/os.h>

void OSYieldThread (void);

Parameters

None.

Return Values

None.

Description

Performs thread rescheduling. The current thread attempts to relinquish the CPU to provide other threads of the same scheduling priority with a chance to run. If there are no other threads with the same scheduling priority in the run queue, this function does nothing.

NOTE:
If any thread that can run has a higher priority, this thread would already be running.

Do Not Call From

Callbacks Do not call this function from any callback function.

Revision History

2013-05-08 Automated cleanup pass.
2012-08-01 Cleanup pass.
2010-08-30 Initial version.


CONFIDENTIAL