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

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

Undocumented

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

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)

overrides twisted.application.internet.TimerService.__init__

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 startService(self): (source)

from twisted.application.service.IService

overrides twisted.application.internet.TimerService.startService

Start the service.

def _setupMonitor(self): (source)

Undocumented

def stopService(self): (source)

from twisted.application.service.IService

overrides twisted.application.internet.TimerService.stopService

Stop the service.

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

def monitorFile(self, name, callback, interval=10): (source)

Undocumented

def unmonitorFile(self, name): (source)

Undocumented

def _monitor(self): (source)

Undocumented

API Documentation for Twisted, generated by pydoctor at 2013-04-03 11:20:05.