Part of twisted.application.service View Source View In Hierarchy
Known implementations: twisted.application.service.Service
A service.
Run start-up and shut-down code at the appropriate times.| Instance Variables | name | The name of the service (or None)
(type: string
) |
| running | Whether the service is running.
(type: boolean
) |
| 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 | startService | Start the service. |
| Method | stopService | Stop the service. |
| Method | privilegedStartService | Do preparation work for starting 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.