t.i.t.Cooperator(object) : class documentation

Part of twisted.internet.task View Source View In Hierarchy

Cooperative task scheduler.
Method __init__ Create a scheduler-like object to which iterators may be added.
Method coiterate Add an iterator to the list of iterators I am currently running.
Method start Begin scheduling steps.
Method stop Stop scheduling steps. Errback the completion Deferreds of all iterators which have been added and forget about them.
Method _tasks Undocumented
Method _tick Run one scheduler tick.
Method _reschedule Undocumented
def __init__(self, terminationPredicateFactory=_Timer, scheduler=_defaultScheduler, started=True): (source)
Create a scheduler-like object to which iterators may be added.
ParametersterminationPredicateFactoryA 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.
schedulerA 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.
startedA 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.
Returnsa 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.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.