t.w.p.j.c.ConnectComponentAuthenticator(xmlstream.ConnectAuthenticator) : class documentation

Part of twisted.words.protocols.jabber.component View 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__
Method	associateWithStream	Called by the XmlStreamFactory when a connection has been made to the requested peer, and an XmlStream object has been instantiated.

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.

def __init__(self, componentjid, password): (source)

overrides twisted.words.protocols.jabber.xmlstream.ConnectAuthenticator.__init__

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

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 xmlstream The XmlStream that will be passing events to this Authenticator. (type: XmlStream )

API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.