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

class documentation

`class ListenAuthenticator(Authenticator): (source)`

Known subclasses: `twisted.words.protocols.jabber.component.ListenComponentAuthenticator`

View In Hierarchy

Authenticator for receiving entities.

Method | `associateWithStream` | Called by the XmlStreamFactory when a connection has been made.
Method | `streamStarted` | Called by the XmlStream when the stream has started.
Class Variable | `namespace` | Undocumented

Inherited from `Authenticator`:

Method | `__init__` | Undocumented
Method | `connectionMade` | Called by the XmlStream when the underlying socket connection is in place.
Instance Variable | `xmlstream` | The XmlStream that needs authentication

def associateWithStream(self, xmlstream): (source)
overrides `twisted.words.protocols.jabber.xmlstream.Authenticator.associateWithStream`
overridden in `twisted.words.protocols.jabber.component.ListenComponentAuthenticator`

Called by the XmlStreamFactory when a connection has been made.

Extend `Authenticator.associateWithStream` to set the `XmlStream` to be non-initiating.

def streamStarted(self, rootElement): (source)
overrides `twisted.words.protocols.jabber.xmlstream.Authenticator.streamStarted`
overridden in `twisted.words.protocols.jabber.component.ListenComponentAuthenticator`

Called by the XmlStream when the stream has started.

This extends `Authenticator.streamStarted` to extract further information from the stream headers from `rootElement`.

namespace: `Optional[str]` = (source)

Undocumented