twisted.application.service.MultiService : API documentation

Straightforward Service Container.

Hold a collection of services, and manage them in a simplistic way. No service will wait for another, but this object itself will not finish shutting down until all of its child services will finish.

Method	__init__	Undocumented
Method	privilegedStartService	Do preparation work for starting the service.
Method	startService	Start the service.
Method	stopService	Stop the service.
Method	getServiceNamed	Get the child service with a given name.
Method	__iter__	Get an iterator over all child services.
Method	addService	Add a child service.
Method	removeService	Remove a child service.

Inherited from Service:

Method	__getstate__	Undocumented
Method	setName	Set the name of the service.
Method	setServiceParent	Set the parent of the service.
Method	disownServiceParent	Use this API to remove an `IService` from an `IServiceCollection`.

def __init__(self): (source)

overridden in twisted.mail.mail.MailService, twisted.web2.tap.Web2Service, twisted.words.protocols.jabber.component.ServiceManager

Undocumented

def privilegedStartService(self): (source)

from twisted.application.service.IService

overrides twisted.application.service.Service.privilegedStartService

Do preparation work for starting the service.

Here things which should be done before changing directory, root or shedding privileges are done.

def startService(self): (source)

from twisted.application.service.IService

overrides twisted.application.service.Service.startService

overridden in twisted.web2.tap.Web2Service

Start the service.

def stopService(self): (source)

from twisted.application.service.IService

overrides twisted.application.service.Service.stopService

overridden in twisted.web2.tap.Web2Service

Stop the service.

Returns a Deferred which is triggered when the service has finished shutting down. If shutting down is immediate, a value can be returned (usually, None). (type: Deferred )

def getServiceNamed(self, name): (source)

from twisted.application.service.IServiceCollection

Get the child service with a given name.

Parameters	name	(type: `str` )
Returns	(type: `IService` )
Raises	KeyError	Raised if the service has no child with the given name.

def __iter__(self): (source)

from twisted.application.service.IServiceCollection

Get an iterator over all child services.

def addService(self, service): (source)

from twisted.application.service.IServiceCollection

Add a child service.

Parameters	service	(type: `IService` )
Raises	RuntimeError	Raised if the service has a child with the given name.

def removeService(self, service): (source)

from twisted.application.service.IServiceCollection

Remove a child service.

Only implementations of IService.disownServiceParent should use this method.

Parameters	service	(type: `IService` )
Returns	a `Deferred` which is triggered when the service has finished shutting down. If shutting down is immediate, a value can be returned (usually, `None`). (type: `Deferred` )
Raises	ValueError	Raised if the given service is not a child.

t.a.s.MultiService(Service) : class documentation