twisted.application.service.Service : API documentation

Known subclasses: twisted.application.internet._VolatileDataService, twisted.application.internet.ClientService, twisted.application.internet.CooperatorService, twisted.application.internet.StreamServerEndpointService, twisted.application.service.MultiService, twisted.manhole.service.Service, twisted.names.secondary.SecondaryAuthorityService, twisted.runner.procmon.ProcessMonitor, twisted.words.protocols.jabber.component.Service

Implements interfaces: twisted.application.service.IService

Base class for services.

Most services should inherit from this class. It handles the book-keeping responsibilities of starting and stopping, as well as not serializing this book-keeping information.

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`.
Method	privilegedStartService	Do preparation work for starting the service.
Method	startService	Start the service.
Method	stopService	Stop the service.

def __getstate__(self): (source)

overridden in twisted.application.internet._VolatileDataService, twisted.manhole.service.Service, twisted.runner.procmon.ProcessMonitor

Undocumented

def setName(self, name): (source)

from twisted.application.service.IService

Set the name of the service.

Raises RuntimeError Raised if the service already has a parent.

def setServiceParent(self, parent): (source)

from twisted.application.service.IService

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

from twisted.application.service.IService

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

from twisted.application.service.IService

overridden in twisted.application.internet._AbstractServer, twisted.application.internet.StreamServerEndpointService, twisted.application.service.MultiService

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

overridden in twisted.application.internet._AbstractClient, twisted.application.internet._AbstractServer, twisted.application.internet.ClientService, twisted.application.internet.CooperatorService, twisted.application.internet.StreamServerEndpointService, twisted.application.internet.TimerService, twisted.application.service.MultiService, twisted.names.secondary.SecondaryAuthorityService, twisted.runner.procmon.ProcessMonitor

Start the service.

def stopService(self): (source)

from twisted.application.service.IService

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)

API Documentation for Twisted, generated by pydoctor at 2016-04-04 15:02:49.

twisted.application.service.Service(object) class documentation

`twisted.application.service.Service(object)` class documentation