t.m.m.FileMonitoringService(internet.TimerService) : class documentation

Part of twisted.mail.mail View Source View In Hierarchy

Method __init__
Method startService Start the service.
Method stopService Stop the service.
Method monitorFile Undocumented
Method unmonitorFile Undocumented
Method _setupMonitor Undocumented
Method _monitor Undocumented

Inherited from TimerService:

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 _failed Undocumented

Inherited from _VolatileDataService (via TimerService):

Method __getstate__ Undocumented

Inherited from Service (via TimerService, _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.
def __init__(self): (source)
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): (source)
Start the service.
def _setupMonitor(self): (source)
def stopService(self): (source)
Stop the service.
Returnsa Deferred which is fired when the currently running call (if any) is finished. (type: Deferred)
def monitorFile(self, name, callback, interval=10): (source)
def unmonitorFile(self, name): (source)
def _monitor(self): (source)
API Documentation for Twisted, generated by pydoctor at 2013-04-03 11:20:05.