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

interface documentation

`class IResolutionReceiver(Interface): (source)`

Known implementations: `twisted.internet._resolver.FirstOneWins`

View In Hierarchy

An `IResolutionReceiver` receives the results of a hostname resolution in progress, initiated by an `IHostnameResolver`.

Present Since
Twisted 17.1.0

Method | `addressResolved` | An internet address. This is called when an address for the given name is discovered. In the current implementation this practically means `IPv4Address` or `IPv6Address`, but implementations of this interface should be lenient to other types being passed to this interface as well, for future-proofing.
Method | `resolutionBegan` | A hostname resolution began.
Method | `resolutionComplete` | Resolution has completed; no further addresses will be relayed to `IResolutionReceiver.addressResolved`.

def addressResolved(address: `IAddress`): (source)

An internet address. This is called when an address for the given name is discovered. In the current implementation this practically means `IPv4Address` or `IPv6Address`, but implementations of this interface should be lenient to other types being passed to this interface as well, for future-proofing.

Parameters
address:`IAddress` | An address object.

def resolutionBegan(resolutionInProgress: `IHostResolution`): (source)

A hostname resolution began.

Parameters
resolutionInProgress:`IHostResolution` | an `IHostResolution`.

def resolutionComplete(): (source)

Resolution has completed; no further addresses will be relayed to `IResolutionReceiver.addressResolved`.