# Class k.t.WaitCondition(object):

Part of kiwi.tasklet View In Hierarchy

Known subclasses: kiwi.tasklet.WaitForCall, kiwi.tasklet.WaitForIdle, kiwi.tasklet.WaitForIO, kiwi.tasklet.WaitForMessages, kiwi.tasklet.WaitForProcess, kiwi.tasklet.WaitForSignal, kiwi.tasklet.WaitForTasklet, kiwi.tasklet.WaitForTimeout

Base class for all wait-able condition objects.

WaitConditions are used in a yield statement inside tasklets body for specifying what event(s) it should wait for in order to receive control once more.

Method | __init__ | Abstract base class, do not call directly
Method | arm | Prepare the wait condition to receive events.
Method | disarm | Stop the wait condition from receiving events.

def __init__(self):
overridden in kiwi.tasklet.WaitForCall, kiwi.tasklet.WaitForIdle, kiwi.tasklet.WaitForIO, kiwi.tasklet.WaitForMessages, kiwi.tasklet.WaitForProcess, kiwi.tasklet.WaitForSignal, kiwi.tasklet.WaitForTasklet, kiwi.tasklet.WaitForTimeout
Abstract base class, do not call directly

def arm(self, tasklet):
overridden in kiwi.tasklet.WaitForCall, kiwi.tasklet.WaitForIdle, kiwi.tasklet.WaitForIO, kiwi.tasklet.WaitForMessages, kiwi.tasklet.WaitForProcess, kiwi.tasklet.WaitForSignal, kiwi.tasklet.WaitForTasklet, kiwi.tasklet.WaitForTimeout

Prepare the wait condition to receive events.

When a wait condition receives the event it is waiting for, it should call the method `wait_condition_fired` of the tasklet with the wait condition as argument. The method returns True or False; if it returns True, it means the WaitCondition object must "rearm" itself (continue to monitor events), otherwise it should disarm.

Parameters | tasklet | the tasklet instance the wait condition is to be associated with.
Note | this method normally should not be called directly by the programmer.

def disarm(self):
overridden in kiwi.tasklet.WaitForCall, kiwi.tasklet.WaitForIdle, kiwi.tasklet.WaitForIO, kiwi.tasklet.WaitForMessages, kiwi.tasklet.WaitForProcess, kiwi.tasklet.WaitForSignal, kiwi.tasklet.WaitForTasklet, kiwi.tasklet.WaitForTimeout
Stop the wait condition from receiving events.

Note | this method normally should not be called by the programmer.