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

class documentation

`class ConnectAuthenticator(Authenticator): (source)`

Known subclasses: `twisted.words.protocols.jabber.client.BasicAuthenticator`, `twisted.words.protocols.jabber.client.XMPPAuthenticator`, `twisted.words.protocols.jabber.component.ConnectComponentAuthenticator`

View In Hierarchy

Authenticator for initiating entities.

Method | `__init__` | Undocumented
Method | `connectionMade` | Called by the XmlStream when the underlying socket connection is in place.
Method | `initializeStream` | Perform stream initialization procedures.
Method | `streamStarted` | Called by the XmlStream when the stream has started.
Class Variable | `namespace` | Undocumented
Instance Variable | `otherHost` | Undocumented

Inherited from `Authenticator`:

Method | `associateWithStream` | Called by the XmlStreamFactory when a connection has been made to the requested peer, and an XmlStream object has been instantiated.
Instance Variable | `xmlstream` | The XmlStream that needs authentication

def __init__(self, otherHost): (source)
overrides `twisted.words.protocols.jabber.xmlstream.Authenticator.__init__`
overridden in `twisted.words.protocols.jabber.client.BasicAuthenticator`, `twisted.words.protocols.jabber.client.XMPPAuthenticator`, `twisted.words.protocols.jabber.component.ConnectComponentAuthenticator`

Undocumented

def connectionMade(self): (source)
overrides `twisted.words.protocols.jabber.xmlstream.Authenticator.connectionMade`

Called by the XmlStream when the underlying socket connection is in place.

This allows the Authenticator to send an initial root element, if it's connecting, or wait for an inbound root from the peer if it's accepting the connection.

Subclasses can use self.xmlstream.send() to send any initial data to the peer.

def initializeStream(self): (source)

Perform stream initialization procedures.

An `XmlStream` holds a list of initializer objects in its `initializers` attribute. This method calls these initializers in order and dispatches the `STREAM_AUTHD_EVENT` event when the list has been successfully processed. Otherwise it dispatches the `INIT_FAILED_EVENT` event with the failure.

Initializers may return the special `Reset` object to halt the initialization processing. It signals that the current initializer was successfully processed, but that the XML Stream has been reset. An example is the TLSInitiatingInitializer.

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

Called by the XmlStream when the stream has started.

This extends `Authenticator.streamStarted` to extract further stream headers from `rootElement`, optionally wait for stream features being received and then call `initializeStream`.

namespace: `Optional[str]` = (source)
overridden in `twisted.words.protocols.jabber.client.BasicAuthenticator`, `twisted.words.protocols.jabber.client.XMPPAuthenticator`

Undocumented

otherHost = (source)

Undocumented