inline threads::thread_restart_state suspend(
threads::thread_schedule_state state =
threads::thread_schedule_state::pending,
const util::thread_description& description =
pika::util::thread_description(
"this_thread::suspend"),
pika::error_code& ec = throws)
inline threads::thread_restart_state suspend(
threads::thread_schedule_state state =
threads::thread_schedule_state::pending,
const util::thread_description& description =
pika::util::thread_description(
"this_thread::suspend"),
pika::error_code& ec = throws)Description
The function \awill return control to the thread manager (suspends the current thread). It sets the new state of this thread to the thread state passed as the parameter.
Declared at: libs/pika/threading_base/include/pika/threading_base/thread_helpers.hpp:475
Parameters
- threads::thread_schedule_state state = threads::thread_schedule_state::pending
- const util::thread_description& description = pika::util::thread_description("this_thread::suspend")
- pika::error_code& ec = throws