twisted.application.internet.StreamServerEndpointService(service.Service, object) class documentation

Part of twisted.application.internet View Source (View In Hierarchy)

A StreamServerEndpointService is an IService which runs a server on a listening port described by an IStreamServerEndpoint.

Present Since10.2
Instance Variable factory A server factory which will be used to listen on the endpoint.
Instance Variable endpoint An IStreamServerEndpoint provider which will be used to listen when the service starts.
Method __init__ Undocumented
Method privilegedStartService Start listening on the endpoint.
Method startService Start listening on the endpoint, unless privilegedStartService got around to it already.
Method stopService Stop listening on the port if it is already listening, otherwise, cancel the attempt to listen.
Instance Variable _waitingForPort a Deferred, if listen has yet been invoked on the endpoint, otherwise None.
Instance Variable _raiseSynchronously Defines error-handling behavior for the case where listen(...) raises an exception before startService or privilegedStartService have completed.

Inherited from Service:

Instance Variable running Undocumented
Instance Variable name Undocumented
Instance Variable parent Undocumented
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.
factory =
A server factory which will be used to listen on the endpoint.
endpoint =
An IStreamServerEndpoint provider which will be used to listen when the service starts.
_waitingForPort =
a Deferred, if listen has yet been invoked on the endpoint, otherwise None.
_raiseSynchronously =
Defines error-handling behavior for the case where listen(...) raises an exception before startService or privilegedStartService have completed.
(type: bool)
def __init__(self, endpoint, factory): (source)
Undocumented
def privilegedStartService(self): (source)
from twisted.application.service.IService
overrides twisted.application.service.Service.privilegedStartService

Start listening on the endpoint.

def startService(self): (source)
from twisted.application.service.IService
overrides twisted.application.service.Service.startService

Start listening on the endpoint, unless privilegedStartService got around to it already.

def stopService(self): (source)
from twisted.application.service.IService
overrides twisted.application.service.Service.stopService

Stop listening on the port if it is already listening, otherwise, cancel the attempt to listen.

Returnsa Deferred which fires with None when the port has stopped listening.
API Documentation for Twisted, generated by pydoctor at 2020-03-20 23:54:06.