twisted.application.internet.StreamServerEndpointService : API documentation

class documentation

class twisted.application.internet.StreamServerEndpointService(service.Service): (source)

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

Present Since 10.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	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	__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 = (source)

A server factory which will be used to listen on the endpoint.

endpoint = (source)

An IStreamServerEndpoint provider which will be used to listen when the service starts.

_waitingForPort = (source)

a Deferred, if listen has yet been invoked on the endpoint, otherwise None.

_raiseSynchronously = (source)

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.

Returns a Deferred which fires with None when the port has stopped listening.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.