twisted.words.protocols.jabber.xmlstream

module documentation

(source)

XMPP XML Streams

Building blocks for setting up XML Streams, including helping classes for doing authentication on either client or server side, and working with XML Stanzas.

Class	`Authenticator`	Base class for business logic of initializing an XmlStream
Class	`BaseFeatureInitiatingInitializer`	Base class for initializers with a stream feature.
Class	`ConnectAuthenticator`	Authenticator for initiating entities.
Class	`FeatureNotAdvertized`	Exception indicating a stream feature was not advertized, while required by the initiating entity.
Class	`IQ`	Wrapper for an iq stanza.
Class	`ListenAuthenticator`	Authenticator for receiving entities.
Class	`StreamManager`	Business logic representing a managed XMPP connection.
Class	`TimeoutError`	Exception raised when no IQ response has been received before the configured timeout.
Class	`TLSError`	TLS base exception.
Class	`TLSFailed`	Exception indicating failed TLS negotiation
Class	`TLSInitiatingInitializer`	TLS stream initializer for the initiating entity.
Class	`TLSNotSupported`	Exception indicating missing TLS support.
Class	`TLSRequired`	Exception indicating required TLS negotiation.
Class	`XmlStream`	XMPP XML Stream protocol handler.
Class	`XmlStreamFactory`	Factory for Jabber XmlStream objects as a reconnecting client.
Class	`XmlStreamServerFactory`	Factory for Jabber XmlStream objects as a server.
Class	`XMPPHandler`	XMPP protocol handler.
Class	`XMPPHandlerCollection`	Collection of XMPP subprotocol handlers.
Function	`hashPassword`	Create a SHA1-digest string of a session identifier and password.
Function	`toResponse`	Create a response stanza from another stanza.
Function	`upgradeWithIQResponseTracker`	Enhances an XmlStream for iq response tracking.
Variable	`INIT_FAILED_EVENT`	Token dispatched by `Authenticator` when the stream has failed to be initialized
Variable	`NS_STREAMS`	Undocumented
Variable	`NS_XMPP_TLS`	Undocumented
Variable	`Reset`	Token to signal that the XML stream has been reset.
Variable	`ssl`	Undocumented
Variable	`STREAM_AUTHD_EVENT`	Token dispatched by `Authenticator` when the stream has been completely initialized
Variable	`STREAM_CONNECTED_EVENT`	This event signals that the connection has been established.
Variable	`STREAM_END_EVENT`	This event signals that the connection has been closed.
Variable	`STREAM_ERROR_EVENT`	This event signals that a parse error occurred.
Variable	`STREAM_START_EVENT`	This event signals that the root element of the XML Stream has been received. For XMPP, this would be the `<stream:stream ...>` opening tag.

def hashPassword(sid, password): (source)

Create a SHA1-digest string of a session identifier and password.

Parameters
sid:`unicode`.	The stream session identifier.
password:`unicode`.	The password to be hashed.

def toResponse(stanza, stanzaType=None): (source)

Create a response stanza from another stanza.

This takes the addressing and id attributes from a stanza to create a (new, empty) response stanza. The addressing attributes are swapped and the id copied. Optionally, the stanza type of the response can be specified.

Parameters
stanza:`domish.Element`	the original stanza
stanzaType:`str`	optional response stanza type
Returns
`domish.Element`	the response stanza.

def upgradeWithIQResponseTracker(xs): (source)

Enhances an XmlStream for iq response tracking.

This makes an XmlStream object provide IIQResponseTracker. When a response is an error iq stanza, the deferred has its errback invoked with a failure that holds a StanzaError that is easier to examine.

INIT_FAILED_EVENT: str. = (source)

Token dispatched by Authenticator when the stream has failed to be initialized

NS_STREAMS: str = (source)

Undocumented

NS_XMPP_TLS: str = (source)

Undocumented

Reset: Basic object. = (source)

Token to signal that the XML stream has been reset.

ssl = (source)

Undocumented

STREAM_AUTHD_EVENT: str. = (source)

Token dispatched by Authenticator when the stream has been completely initialized

STREAM_CONNECTED_EVENT: str. = (source)

This event signals that the connection has been established.

STREAM_END_EVENT: str. = (source)

This event signals that the connection has been closed.

STREAM_ERROR_EVENT: str. = (source)

This event signals that a parse error occurred.

STREAM_START_EVENT: str. = (source)

This event signals that the root element of the XML Stream has been received. For XMPP, this would be the <stream:stream ...> opening tag.