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

Part of twisted.application.service (View In Hierarchy)

Known implementations: twisted.application.service.Service, twisted.application.test.test_service.AlmostService

A service.

Run start-up and shut-down code at the appropriate times.

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):

Set the name of the service.

RaisesRuntimeErrorRaised if the service already has a parent.
def setServiceParent(parent):

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

RaisesRuntimeErrorRaised 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():

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.

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

Start the service.

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

Do preparation work for starting the service.

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

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.