t.i.t.LoopingCall : class documentation

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

Call a function repeatedly.

If f returns a deferred, rescheduling will not take place until the deferred has fired. The result value is ignored.
Instance VariablesfThe function to call.
aA tuple of arguments to pass the function.
kwA dictionary of keyword arguments to pass to the function.
clockA provider of twisted.internet.interfaces.IReactorTime. The default is twisted.internet.reactor. Feel free to set this to something else, but it probably ought to be set *before* calling start.
_lastTimeThe time at which this instance most recently scheduled itself to run. (type: float )
Method __init__ Undocumented
Method start Start running function every interval seconds.
Method stop Stop running function.
Method __call__ Undocumented
Method __repr__ Undocumented
Method _reschedule Schedule the next iteration of this looping call.
def __init__(self, f, *a, **kw): (source)
Undocumented
def start(self, interval, now=True): (source)
Start running function every interval seconds.
ParametersintervalThe number of seconds between calls. May be less than one. Precision will depend on the underlying platform, the available hardware, and the load on the system.
nowIf True, run this call right now. Otherwise, wait until the interval has elapsed before beginning.
ReturnsA Deferred whose callback will be invoked with self when self.stop is called, or whose errback will be invoked when the function raises an exception or returned a deferred that has its errback invoked.
def stop(self): (source)
Stop running function.
def __call__(self): (source)
Undocumented
def _reschedule(self): (source)
Schedule the next iteration of this looping call.
def __repr__(self): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.