OSSleepThread

Syntax

#include <revolution/os.h>

void OSSleepThread (OSThreadQueue* queue);

Arguments

*`queue`*	Pointer to the thread queue into which the current thread will be inserted.

Return Values

None.

Description

Suspends the current thread and inserts it into the thread queue specified by queue. The thread will remain suspended until the OSWakeupThread function is called with queue as an argument.

This function sometimes puts the current thread to sleep, so it cannot be called from callback functions. For precautions when calling similar functions, refer to Interrupts and Callback Functions.

Revision History

2007/09/25 Added information on the sleeping status of threads.
2006/03/01 Initial version.