twisted.application.service.IService : API documentation

Attribute	name	A `str` which is the name of the service or `None`.
Attribute	running	A `boolean` which indicates whether the service is running.
Attribute	parent	An `IServiceCollection` which is the parent or `None`.
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`.
Method	startService	Start the service.
Method	stopService	Stop the service.
Method	privilegedStartService	Do preparation work for starting the service.

name =

A str which is the name of the service or None.

running =

A boolean which indicates whether the service is running.

parent =

An IServiceCollection which is the parent or None.

def setName(name): (source)

Set the name of the service.

Raises RuntimeError Raised if the service already has a parent.

def setServiceParent(parent): (source)

Set the parent of the service. This method is responsible for setting the parent attribute on this service (the child service).

Raises RuntimeError Raised if the service already has a parent or if the service has a name and the parent already has a child by that name.

def disownServiceParent(): (source)

Use this API to remove an IService from an IServiceCollection.

This method is used symmetrically with setServiceParent in that it sets the parent attribute on the child.

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 startService(): (source)

Start the service.

def stopService(): (source)

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 privilegedStartService(): (source)

Do preparation work for starting the service.

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

twisted.application.service.IService(Interface) interface documentation

`twisted.application.service.IService(Interface)` interface documentation