WaitForKickTimeoutIn() [2/2]

bool drama::thread::TAction::WaitForKickTimeoutIn ( unsigned  seconds, sds::IdPtr *const  arg = 0  )

inlineinherited

Block the current thread until a kick for the action is received or a duration in seconds has passed.

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

seconds	The maximum time span during which the thread will block waiting to be notified. duration is in seconds.
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, this is not written to.

Returns

Returns true if the kick was received, false for a timeout.

References drama::CreateRunDramaTask().