NAME

omni::sync::join_thread

A static function of omni::sync

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


SYNOPSIS

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.

top

DESCRIPTION

No description.

top

PARAMETERS

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

top

RETURN VALUES

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

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
Visit the examples page for more.

top