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`.`internet`.`interfaces`.`IListeningPort``

interface documentation

`class IListeningPort(Interface): (source)`

Known implementations: `twisted.internet.iocpreactor.tcp.Port`, `twisted.internet.iocpreactor.udp.Port`, `twisted.internet.tcp.Port`, `twisted.internet.udp.Port`, `twisted.pair.tuntap.TuntapPort`, `twisted.internet.testing._FakePort`

View In Hierarchy

A listening port.

Method | `getHost` | Get the host that this port is listening for.
Method | `startListening` | Start listening on this port.
Method | `stopListening` | Stop listening on this port.

def getHost() -> `IAddress`: (source)

Get the host that this port is listening for.

Returns
`IAddress` | An `IAddress` provider.

def startListening(): (source)

Start listening on this port.

Raises
`CannotListenError` | If it cannot listen on this port (e.g., it is a TCP port and it cannot bind to the required port number).

def stopListening() -> `Optional[Deferred[None]]`: (source)

Stop listening on this port.

If it does not complete immediately, will return Deferred that fires upon completion.