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 may put the current thread to sleep. For precautions when calling similar functions, refer to Interrupts and Callback Functions.

See Also

Thread Functions, Thread Synchronization Functions, OSInitThreadQueue, OSWakeupThread Interrupts and Callback Functions

Revision History

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


CONFIDENTIAL