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

class documentation

`class XmlStreamFactoryMixin(BootstrapMixin): (source)`

Known subclasses: `twisted.words.xish.xmlstream.XmlStreamFactory`

View In Hierarchy

XmlStream factory mixin that takes care of event handlers.

All positional and keyword arguments passed to create this factory are passed on as-is to the protocol.

Method | `__init__` | Undocumented
Method | `buildProtocol` | Create an instance of XmlStream.
Instance Variable | `args` | Positional arguments passed to the protocol upon instantiation.
Instance Variable | `kwargs` | Keyword arguments passed to the protocol upon instantiation.

Inherited from `BootstrapMixin`:

Method | `addBootstrap` | Add a bootstrap event handler.
Method | `installBootstraps` | Install registered bootstrap observers.
Method | `removeBootstrap` | Remove a bootstrap event handler.
Instance Variable | `bootstraps` | The list of registered bootstrap event observers.

def __init__(self, *args, **kwargs): (source)
overrides `twisted.words.xish.xmlstream.BootstrapMixin.__init__`
overridden in `twisted.words.protocols.jabber.xmlstream.XmlStreamFactory`

Undocumented

def buildProtocol(self, addr): (source)
overridden in `twisted.words.xish.xmlstream.XmlStreamFactory`

Create an instance of XmlStream.

The returned instance will have bootstrap event observers registered and will proceed to handle input on an incoming connection.

args: `tuple`. = (source)

Positional arguments passed to the protocol upon instantiation.

kwargs: `dict`. = (source)

Keyword arguments passed to the protocol upon instantiation.