twisted.application.service.MultiService

class documentation

class twisted.application.service.MultiService(Service): (source)

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

Implements interfaces: twisted.application.service.IServiceCollection

View In Hierarchy

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
Instance Variable services Undocumented
Instance Variable namedServices Undocumented
Instance Variable parent An IServiceCollection which is the parent or None.
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:

Instance Variable running A boolean which indicates whether the service is running.
Instance Variable name A str which is the name of the service or None.
Method __getstate__ Undocumented
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.
def __init__(self): (source)
overridden in twisted.mail.mail.MailService, twisted.words.protocols.jabber.component.ServiceManager

Undocumented

services = (source)

Undocumented

(type: list)
namedServices = (source)

Undocumented

(type: dict)
parent = (source)
from twisted.application.service.IService
overrides twisted.application.service.Service.parent

An IServiceCollection which is the parent or None.

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

Start the service.

def stopService(self): (source)
from twisted.application.service.IService
overrides twisted.application.service.Service.stopService

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)
from twisted.application.service.IServiceCollection

Get the child service with a given name.

ParametersnameUndocumented (type: str)
ReturnsUndocumented (type: IService)
RaisesKeyErrorRaised 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.

Only implementations of IService.setServiceParent should use this method.

ParametersserviceUndocumented (type: IService)
RaisesRuntimeErrorRaised 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.

ParametersserviceUndocumented (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 20.12.1 at 2021-02-28 19:53:36.