OSWaitRendezvousWithTimeout

Syntax

#include <cafe/os.h>

BOOL OSWaitRendezvousWithTimeout(OSRendezvous* ren, u32 wmask, OSTimeNanoseconds timeout);

Parameters

ren OSRendezvous on which to wait. OSRendezvous must be initialized prior to calling this function.
wmask Mask applied that determines which processor cores to wait upon.
timeout Minimum number of nanoseconds to busy-wait before returning FALSE.

Adhering to an exact number of nanoseconds is not guaranteed. This function only has a time-inspection granularity roughly equivalent to the processor timebase.

Return Values

Returns TRUE if the OSRendezvous was successful, or FALSE if the timeout elapsed before the OSRendezvous was successful.

Description

Causes the thread or task to wait until the specific set of processor cores all reach the OSRendezvous or until the timeout elapses.

Do Not Call From

Multiple threads This function is not thread-safe.
Callbacks Do not call this function from any callback function.

See Also

OSInitRendezvous
OSWaitRendezvous

Revision History

2013-05-08 Automated cleanup pass.
2012-07-31 Cleanup Pass.
2012-05-25 Matched actual prototype.
2010-08-23 Initial version.


CONFIDENTIAL