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`.`words`.`protocols`.`jabber`.`ijabber`.`IIQResponseTracker``

interface documentation

`class IIQResponseTracker(Interface): (source)`

View In Hierarchy

IQ response tracker interface.

The XMPP stanza `iq` has a request-response nature that fits naturally with deferreds. You send out a request and when the response comes back a deferred is fired.

The `twisted.words.protocols.jabber.client.IQ` class implements a `send` method that returns a deferred. This deferred is put in a dictionary that is kept in an `XmlStream` object, keyed by the request stanzas `id` attribute.

An object providing this interface (usually an instance of `XmlStream`), keeps the said dictionary and sets observers on the iq stanzas of type `result` and `error` and lets the callback fire the associated deferred.

Attribute | `iqDeferreds` | Dictionary of deferreds waiting for an iq response

iqDeferreds = (source)

Dictionary of deferreds waiting for an iq response