twisted.internet.base._ThreePhaseEvent : API documentation

Collection of callables (with arguments) which can be invoked as a group in a particular order.

This provides the underlying implementation for the reactor's system event triggers. An instance of this class tracks triggers for all phases of a single type of event.

Instance Variables	before	A list of the before-phase triggers containing three-tuples of a callable, a tuple of positional arguments, and a dict of keyword arguments
	finishedBefore	A list of the before-phase triggers which have already been executed. This is only populated in the `'BEFORE'` state.
	during	A list of the during-phase triggers containing three-tuples of a callable, a tuple of positional arguments, and a dict of keyword arguments
	after	A list of the after-phase triggers containing three-tuples of a callable, a tuple of positional arguments, and a dict of keyword arguments
	state	A string indicating what is currently going on with this object. One of `'BASE'` (for when nothing in particular is happening; this is the initial value), `'BEFORE'` (when the before-phase triggers are in the process of being executed).

Method	__init__	Undocumented
Method	addTrigger	Add a trigger to the indicate phase.
Method	removeTrigger	Remove a previously added trigger callable.
Method	removeTrigger_BASE	Just try to remove the trigger.
Method	removeTrigger_BEFORE	Remove the trigger if it has yet to be executed, otherwise emit a warning that in the future an exception will be raised when removing an already-executed trigger.
Method	fireEvent	Call the triggers added to this event.
Method	_continueFiring	Call the during and after phase triggers for this event.

def addTrigger(self, phase, callable, *args, **kwargs): (source)

Add a trigger to the indicate phase.

Parameters	phase	One of `'before'`, `'during'`, or `'after'`.
	callable	An object to be called when this event is triggered.
	*args	Positional arguments to pass to `callable`.
	**kwargs	Keyword arguments to pass to `callable`.
Returns	An opaque handle which may be passed to `removeTrigger` to reverse the effects of calling this method.

def removeTrigger(self, handle): (source)

Remove a previously added trigger callable.

Parameters	handle	An object previously returned by `addTrigger`. The trigger added by that call will be removed.
Raises	ValueError	If the trigger associated with `handle` has already been removed or if `handle` is not a valid handle.

def removeTrigger_BEFORE(self, handle): (source)

Remove the trigger if it has yet to be executed, otherwise emit a
warning that in the future an exception will be raised when removing an
already-executed trigger.

@see removeTrigger

t.i.b._ThreePhaseEvent(object) : class documentation