twisted.application.internet.TimerService(_VolatileDataService) class documentation

Part of twisted.application.internet (View In Hierarchy)

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. (type: IReactorTime)
Instance Variable call Function and arguments to call periodically. (type: tuple of (callable, args, kwargs))
Method __init__
Method startService Start the service.
Method stopService Stop the service.
Method _failed Undocumented

Inherited from _VolatileDataService:

Method __getstate__ Undocumented

Inherited from Service (via _VolatileDataService):

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 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):
overridden in twisted.mail.mail.FileMonitoringService
ParametersstepThe number of seconds between calls. (type: float)
callableFunction to call (type: callable)
argsPositional arguments to pass to function
kwargsKeyword arguments to pass to function
def startService(self):
from twisted.application.service.IService
overrides twisted.application.service.Service.startService
overridden in twisted.mail.mail.FileMonitoringService

Start the service.

def _failed(self, why):
Undocumented
def stopService(self):
from twisted.application.service.IService
overrides twisted.application.service.Service.stopService
overridden in twisted.mail.mail.FileMonitoringService

Stop the service.

Returnsa Deferred which is fired when the currently running call (if any) is finished. (type: Deferred)
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.