twisted.application.internet.TimerService : API documentation

class documentation

class twisted.application.internet.TimerService(_VolatileDataService): (source)

Known subclasses: twisted.mail.mail.FileMonitoringService

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`.
Instance Variable	call	Function and arguments to call periodically.
Class Variable	volatile	Undocumented
Method	__init__
Instance Variable	step	Undocumented
Method	startService	Start the service.
Method	stopService	Stop the service.
Instance Variable	_loop	Undocumented
Instance Variable	_loopFinished	Undocumented
Method	_failed	Undocumented

Inherited from _VolatileDataService:

Method

__getstate__

Undocumented

Inherited from Service (via _VolatileDataService):

Instance Variable	running	A `boolean` which indicates whether the service is running.
Instance Variable	name	A `str` which is the name of the service or `None`.
Instance Variable	parent	An `IServiceCollection` which is the parent or `None`.
Method	setName	Set the name of the service.
Method	setServiceParent	Set the parent of the service. This method is responsible for setting the `parent` attribute on this service (the child service).
Method	disownServiceParent	Use this API to remove an `IService` from an `IServiceCollection`.
Method	privilegedStartService	Do preparation work for starting the service.

clock = (source)

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 = (source)

Function and arguments to call periodically.

(type: tuple of (callable, args, kwargs))

volatile = (source)

overrides twisted.application.internet._VolatileDataService.volatile

Undocumented

(type: list[str])

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