NAME

omni::yield_thread

A function of omni

SYNOPSIS top

Causes the current thread to be rescheduled by the OS. Not to be confused with sleep, this function does not stop the current thread, it merely calls the OS to have its thread scheduler move the current thread to a new thread schedule. If the current thread is of higher priority (or 'real time') this call might not have an effect.

#include <omni/sync/this_thread.hpp>
inline bool omni::yield_thread()

DESCRIPTION top

No description found.

EXAMPLE top

Currently no examples.

Visit the examples page for more.

RETURN VALUES top

No return value.

ERRORS top

No errors specific to this context.

CONSIDERATIONS top

No extra considerations.

PLATFORM SPECIFIC top

Nothing platform specific to account for.

NOTES top

No additional notes.