omni::join_thread
NAME

omni::join_thread

A function of omni

SYNOPSIS top

Blocks the calling thread until the thread passed in has finished executing (by normal means or cancellation) or the specified timeout has been reached, which ever happens first.

#include <omni/types/thread_t.hpp>
inline bool omni::join_thread(omni::thread_handle_t handle, unsigned long timeout)

DESCRIPTION top

No description found.

PARAMETERS top

timeout - The timeout (in milliseconds) to wait for a thread to finish (default of infinite)

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

RETURN VALUES top

True if the thread has been joined successfully, false if the operation times out or there was an error

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.