omni::sync::yield_thread

SYNOPSIS

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::sync::yield_thread()


top

DESCRIPTION

No description found.

top

RETURN VALUES

No return value.

top

ERRORS

No errors specific to this context.

top

CONSIDERATIONS

No extra considerations.

top

PLATFORM SPECIFIC

Nothing platform specific to account for.

top

NOTES

No additional notes.

top

EXAMPLE
Currently no examples.
Visit the examples page for more.

top