twisted.application.internet._AbstractServer(_VolatileDataService) class documentation

Part of twisted.application.internet View Source (View In Hierarchy)
Class Variable volatile list of attribute to remove from pickling. (type: list)
Instance Variable method the type of method to call on the reactor, one of TCP, UDP, SSL or UNIX. (type: str)
Instance Variable reactor the current running reactor. (type: a provider of IReactorTCP, IReactorUDP, IReactorSSL or IReactorUnix.)
Method __init__ Undocumented
Method privilegedStartService Do preparation work for starting the service.
Method startService Start the service.
Method stopService Stop the service.
Instance Variable _port instance of port set when the service is started. (type: a provider of twisted.internet.interfaces.IListeningPort.)
Method _getPort Wrapper around the appropriate listen method of the reactor.

Inherited from Service (via _VolatileDataService):

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.

Inherited from Service (via _VolatileDataService):

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.
volatile =
list of attribute to remove from pickling. (type: list)
method =
the type of method to call on the reactor, one of TCP, UDP, SSL or UNIX. (type: str)
reactor =
the current running reactor. (type: a provider of IReactorTCP, IReactorUDP, IReactorSSL or IReactorUnix.)
_port =
instance of port set when the service is started. (type: a provider of twisted.internet.interfaces.IListeningPort.)
def __init__(self, *args, **kwargs): (source)
Undocumented
def privilegedStartService(self): (source)
from twisted.application.service.IService
overrides twisted.application.service.Service.privilegedStartService

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
overrides twisted.application.service.Service.startService

Start the service.

def stopService(self): (source)
from twisted.application.service.IService
overrides twisted.application.service.Service.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 _getPort(self): (source)

Wrapper around the appropriate listen method of the reactor.

Returnsthe port object returned by the listen method. (type: an object providing twisted.internet.interfaces.IListeningPort.)
API Documentation for Twisted, generated by pydoctor at 2016-04-11 10:39:53.