API docs for “twisted.internet.task.Cooperator”

Line #	Kind	Name	Docs
187	Method	__init__	Create a scheduler-like object to which iterators may be added.
217	Method	coiterate	Add an iterator to the list of iterators I am currently running.
276	Method	start	Begin scheduling steps.
287	Method	stop	Stop scheduling steps. Errback the completion Deferreds of all
233	Method	_tasks	Undocumented
243	Method	_tick	Run one scheduler tick.
268	Method	_reschedule	Undocumented

def __init__(self, terminationPredicateFactory=_Timer, scheduler=_defaultScheduler, started=True): (source)

Create a scheduler-like object to which iterators may be added.

Parameters	terminationPredicateFactory	A no-argument callable which will be invoked at the beginning of each step and should return a no-argument callable which will return False when the step should be terminated. The default factory is time-based and allows iterators to run for 1/100th of a second at a time.
	scheduler	A one-argument callable which takes a no-argument callable and should invoke it at some future point. This will be used to schedule each step of this Cooperator.
	started	A boolean which indicates whether iterators should be stepped as soon as they are added, or if they will be queued up until `Cooperator.start` is called.

def coiterate(self, iterator, doneDeferred=None): (source)

Add an iterator to the list of iterators I am currently running.

Returns a Deferred that will fire when the iterator finishes.

def _tasks(self): (source)

Undocumented

def _tick(self): (source)

Run one scheduler tick.

def _reschedule(self): (source)

Undocumented

def start(self): (source)

Begin scheduling steps.

def stop(self): (source)

Stop scheduling steps. Errback the completion Deferreds of all iterators which have been added and forget about them.

Class t.i.t.Cooperator(object):