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

Part of twisted.application.service View Source View In Hierarchy

Known subclasses: twisted.mail.mail.MailService, twisted.web2.tap.Web2Service, twisted.words.protocols.jabber.component.ServiceManager

Implements interfaces: twisted.application.service.IServiceCollection

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 Remove the parent of the service.
def __init__(self): (source)
Undocumented
def privilegedStartService(self): (source)

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)
Start the service.
def stopService(self): (source)
Stop the service.
Returnsa 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)
Get the child service with a given name.
Parametersname (type: str )
Returns (type: IService )
RaisesKeyErrorRaised if the service has no child with the given name.
def __iter__(self): (source)
Get an iterator over all child services
def addService(self, service): (source)
Add a child service.
Parametersservice (type: IService )
RaisesRuntimeErrorRaised if the service has a child with the given name.
def removeService(self, service): (source)
Remove a child service.
Parametersservice (type: IService )
Returnsa 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 )
RaisesValueErrorRaised if the given service is not a child.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.