t.a.s.IServiceCollection(Interface) : interface documentation

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

Known implementations: twisted.application.service.MultiService

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	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.

def getServiceNamed(name): (source)

Get the child service with a given name.

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

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.

Raises RuntimeError Raised if the service has a child with the given name.

def removeService(service): (source)

Remove a child service.

Only implementations of IService.disownServiceParent should use this method.

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.

API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.