MACRO

OMNI_THREAD_YIELD - A helper macro calling the platform thread yield function.

SYNOPSIS top

Calls the platform thread yield function to yield the current thread.

DESCRIPTION top

Calling this macro will call the underlying function to yield the current thread to others based on the current thread schedule policy. This macro is called by the omni::sync::yield_thread function as well.

CONSIDERATIONS top

No special considerations

PLATFORM SPECIFIC top

Defined as #define OMNI_THREAD_YIELD() ::SwitchToThread() on Windows platforms and #define OMNI_THREAD_YIELD() ::sched_yield() on others.

NOTES top

None.