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`.`_AbstractServer``

class documentation

`class _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`

Constructor: `_AbstractServer(*args, **kwargs)`

View In Hierarchy

Method | `__init__` | Undocumented
Method | `privilegedStartService` | Do preparation work for starting the service.
Method | `startService` | Start the service.
Method | `stopService` | Stop the service.
Class Variable | `volatile` | list of attribute to remove from pickling.
Instance Variable | `args` | Undocumented
Instance Variable | `kwargs` | Undocumented
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 | `_getPort` | Wrapper around the appropriate listen method of the reactor.
Instance Variable | `_port` | instance of port set when the service is started.

Inherited from `_VolatileDataService`:

Method | `__getstate__` | Undocumented

Inherited from `Service` (via `_VolatileDataService`):

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, *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.

Returns
`Deferred` | a `Deferred` which is triggered when the service has finished shutting down. If shutting down is immediate, a value can be returned (usually, `None`).

volatile: `list` = (source)
overrides `twisted.application.internet._VolatileDataService.volatile`

list of attribute to remove from pickling.

args = (source)

Undocumented

kwargs = (source)

Undocumented

method: `str` = (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.

reactor: a provider of `IReactorTCP`, `IReactorUDP`, `IReactorSSL` or `IReactorUnix`. = (source)

the current running reactor.

def _getPort(self): (source)

Wrapper around the appropriate listen method of the reactor.

Returns
an object providing `twisted.internet.interfaces.IListeningPort`. | the port object returned by the listen method.

_port: a provider of `twisted.internet.interfaces.IListeningPort`. = (source)

instance of port set when the service is started.