twisted.application.internet._AbstractServer

class documentation

class twisted.application.internet._AbstractServer(_VolatileDataService): (source)

Known subclasses: twisted.application.internet.MulticastServer, twisted.application.internet.SSLServer, twisted.application.internet.TCPServer, twisted.application.internet.UDPServer, twisted.application.internet.UNIXDatagramServer, twisted.application.internet.UNIXServer

View In Hierarchy

Class Variable volatile list of attribute to remove from pickling.
Instance Variable method the type of method to call on the reactor, one of TCP, UDP, SSL or UNIX.
Instance Variable reactor the current running reactor.
Method __init__ Undocumented
Instance Variable args Undocumented
Instance Variable kwargs 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.
Method _getPort Wrapper around the appropriate listen method of the reactor.

Inherited from _VolatileDataService:

Method __getstate__ Undocumented

Inherited from Service (via _VolatileDataService):

Instance Variable running A boolean which indicates whether the service is running.
Instance Variable name A str which is the name of the service or None.
Instance Variable 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.
volatile = (source)
overrides twisted.application.internet._VolatileDataService.volatile
list of attribute to remove from pickling.
(type: list)
method = (source)
overridden in twisted.application.internet.MulticastServer, twisted.application.internet.SSLServer, twisted.application.internet.TCPServer, twisted.application.internet.UDPServer, twisted.application.internet.UNIXDatagramServer, twisted.application.internet.UNIXServer
the type of method to call on the reactor, one of TCP, UDP, SSL or UNIX.
(type: str)
reactor = (source)
the current running reactor.
(type: a provider of IReactorTCP, IReactorUDP, IReactorSSL or IReactorUnix.)
_port = (source)
instance of port set when the service is started.
(type: a provider of twisted.internet.interfaces.IListeningPort.)
def __init__(self, *args, **kwargs): (source)

Undocumented

args = (source)

Undocumented

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 20.12.1 at 2021-02-28 19:53:36.