Part of twisted.application.service View Source View In Hierarchy
Known subclasses: twisted.application.internet._VolatileDataService, 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 reponsibilities 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. |
| 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. |
| Parameters | name | (type: str
) |
| Raises | RuntimeError | Raised if the service already has a parent. |
| Parameters | parent | (type: IServiceCollection
) |
| 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. |
Use this API to remove an IService
from an IServiceCollection.
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
) | |
Do preparation work for starting the service.
Here things which should be done before changing directory, root or shedding privileges are done.