Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`application`.`internet`.`StreamServerEndpointService``

class documentation

`class StreamServerEndpointService(service.Service): (source)`

Constructor: `StreamServerEndpointService(endpoint, factory)`

View In Hierarchy

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

Present Since
10.2

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 | `endpoint` | An `IStreamServerEndpoint` provider which will be used to listen when the service starts.
Instance Variable | `factory` | A server factory which will be used to listen on the endpoint.
Instance Variable | `_raiseSynchronously` | Defines error-handling behavior for the case where `listen(...)` raises an exception before `startService` or `privilegedStartService` have completed.
Instance Variable | `_waitingForPort` | a Deferred, if `listen` has yet been invoked on the endpoint, otherwise None.

Inherited from `Service`:

Method | `__getstate__` | Undocumented
Method | `disownServiceParent` | Use this API to remove an `IService` from an `IServiceCollection`.
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).
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`.
Instance Variable | `running` | A `boolean` which indicates whether the service is running.

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.

endpoint = (source)

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

factory = (source)

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

_raiseSynchronously: `bool` = (source)

Defines error-handling behavior for the case where `listen(...)` raises an exception before `startService` or `privilegedStartService` have completed.

_waitingForPort = (source)

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