twisted.application.internet.TimerService : API documentation

Service to periodically call a function

Every step seconds call the given function with the given arguments. The service starts the calls when it starts, and cancels them when it stops.

Instance Variable	clock	Source of time. This defaults to `None` which is causes `twisted.internet.reactor` to be used. Feel free to set this to something else, but it probably ought to be set before calling `startService`. (type: `IReactorTime`)
Instance Variable	call	Function and arguments to call periodically. (type: `tuple` of `(callable, args, kwargs)`)
Method	__init__
Method	startService	Undocumented
Method	stopService	Stop the service.
Method	_failed	Undocumented

Inherited from _VolatileDataService:

Method

__getstate__

Undocumented

Inherited from Service (via _VolatileDataService):

Method	setName	Undocumented
Method	setServiceParent	Undocumented
Method	disownServiceParent	Undocumented
Method	privilegedStartService	Undocumented

clock =

Source of time. This defaults to None which is causes twisted.internet.reactor to be used. Feel free to set this to something else, but it probably ought to be set *before* calling startService. (type: IReactorTime)

call =

Function and arguments to call periodically. (type: tuple of (callable, args, kwargs))

def __init__(self, step, callable, *args, **kwargs): (source)

overridden in twisted.mail.mail.FileMonitoringService

Parameters	step	The number of seconds between calls. (type: `float`)
	callable	Function to call (type: `callable`)
	args	Positional arguments to pass to function
	kwargs	Keyword arguments to pass to function

def stopService(self): (source)

overrides twisted.application.service.Service.stopService

overridden in twisted.mail.mail.FileMonitoringService

Stop the service.

Returns a Deferred which is fired when the currently running call (if any) is finished. (type: Deferred)

t.a.i.TimerService(_VolatileDataService) : class documentation