◆ WaitForKick()

void drama::thread::TAction::WaitForKick ( sds::IdPtr *const arg = nullptr )

inlineinherited

Block the current thread until a kick for the action is received.

Note - in an action with multiple subsidiary threads, any number of the threads can block waiting for a kick. They will all be woken up when the kick occurs.

Parameters

arg	The argument to the kick, if any. An address of and sds::IdPtr is supplied. If you supply a null pointer, it is ignored. Otherwise, any argument to the kick is copied into here. If there is no argument to the kick, it will refer to a null SDS item.

References drama::CreateRunDramaTask(), DramaTHROW, and drama::Kick.