twisted.application.service.IServiceCollection

interface documentation

class IServiceCollection(Interface): (source)

Known implementations: twisted.application.service.MultiService

View In Hierarchy

Collection of services.

Contain several services, and manage their start-up/shut-down. Services can be accessed by name if they have a name, and it is always possible to iterate over them.

Method __iter__ Get an iterator over all child services.
Method add​Service Add a child service.
Method get​Service​Named Get the child service with a given name.
Method remove​Service Remove a child service.
def __iter__(): (source)
Get an iterator over all child services.
def addService(service): (source)

Add a child service.

Only implementations of IService.setServiceParent should use this method.

Parameters
service:IServiceUndocumented
Raises
RuntimeErrorRaised if the service has a child with the given name.
def getServiceNamed(name): (source)
Get the child service with a given name.
Parameters
name:strUndocumented
Returns
IServiceUndocumented
Raises
KeyErrorRaised if the service has no child with the given name.
def removeService(service): (source)

Remove a child service.

Only implementations of IService.disownServiceParent should use this method.

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