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`.`component`.`ConnectComponentAuthenticator``

class documentation

`class ConnectComponentAuthenticator(xmlstream.ConnectAuthenticator): (source)`

View In Hierarchy

Authenticator to permit an XmlStream to authenticate against a Jabber server as an external component (where the Authenticator is initiating the stream).

Method | `__init__` | No summary
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 | `password` | Undocumented

Inherited from `ConnectAuthenticator`:

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` (via `ConnectAuthenticator`):

Instance Variable | `xmlstream` | The XmlStream that needs authentication

def __init__(self, componentjid, password): (source)
overrides `twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.__init__`

Parameters
componentjid:`str` | Jabber ID that this component wishes to bind to.
password:`str` | Password/secret this component uses to authenticate.

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

Called by the XmlStreamFactory when a connection has been made to the requested peer, and an XmlStream object has been instantiated.

The default implementation just saves a handle to the new XmlStream.

Parameters
xs | Undocumented
xmlstream:`XmlStream` | The XmlStream that will be passing events to this Authenticator.

password = (source)

Undocumented