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`.`xish`.`xmlstream``

module documentation
(source)

XML Stream processing.

An XML Stream is defined as a connection over which two XML documents are exchanged during the lifetime of the connection, one for each direction. The unit of interaction is a direct child element of the root element (stanza).

The most prominent use of XML Streams is Jabber, but this module is generically usable. See Twisted Words for Jabber specific protocol support.

Maintainer: Ralph Meijer

Class | `BootstrapMixin` | XmlStream factory mixin to install bootstrap event observers.
Class | `XmlStream` | Generic Streaming XML protocol handler.
Class | `XmlStreamFactory` | Factory for XmlStream protocol objects as a reconnection client.
Class | `XmlStreamFactoryMixin` | XmlStream factory mixin that takes care of event handlers.