pika::threads::thread_state get_thread_state(
    const pika::threads::thread_id_type& id,
    pika::error_code& ec = throws)

Description

//////////////////////////////////////////////////////////////////////// The function get_thread_state is part of the thread related API. It queries the state of one of the threads known to the thread-manager.

Declared at: libs/pika/threading_base/include/pika/threading_base/thread_helpers.hpp:213

Parameters

const pika::threads::thread_id_type& id

[in] The thread id of the thread the state should be modified for.

pika::error_code& ec = throws

[in,out] this represents the error status on exit, if this is pre-initialized to \athe function will throw on error instead.

Returns

This function returns the thread state of the thread referenced by the \aparameter. If the thread is not known to the thread-manager the return value will be \a