◆ DoWaitForKick()

bool drama::thread::TAction::DoWaitForKick	(	WaitEventDetails *	waitEvent,
		sds::IdPtr *const	arg = `nullptr`
	)

inlineinherited

Wait for a kick event with the waitEvent details given.

Currently this is only used by the KickNotifier. It may end up with wider use.

Parameters

waitEvent	item address returned by SetupWaitForKick.
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.

Returns: false if woken up by SignalWaitingEvent with a code of EntryCode::DramaAbortWaits, true otherwise (normally a kick).