twisted.words.protocols.jabber.xmlstream.StreamManager : API documentation

class documentation

class twisted.words.protocols.jabber.xmlstream.StreamManager(XMPPHandlerCollection): (source)

Business logic representing a managed XMPP connection.

This maintains a single XMPP connection and provides facilities for packet routing and transmission. Business logic modules are objects providing ijabber.IXMPPHandler (like subclasses of XMPPHandler), and added using addHandler.

Instance Variable	xmlstream	currently managed XML stream
Instance Variable	logTraffic	if true, log all traffic.
Method	__init__	Undocumented
Instance Variable	factory	Undocumented
Method	addHandler	Add protocol handler.
Method	initializationFailed	Called when stream initialization has failed.
Method	send	Send data over the XML stream.
Instance Variable	_initialized	Whether the stream represented by `xmlstream` has been initialized. This is used when caching outgoing stanzas.
Instance Variable	_packetQueue	internal buffer of unsent data. See `send` for details.
Method	_connected	Called when the transport connection has been established.
Method	_authd	Called when the stream has been initialized.
Method	_disconnected	Called when the stream has been closed.

Inherited from XMPPHandlerCollection:

Instance Variable	handlers	List of protocol handlers.
Method	__iter__	Act as a container for handlers.
Method	removeHandler	Remove protocol handler.

xmlstream = (source)

currently managed XML stream

(type: XmlStream)

logTraffic = (source)

if true, log all traffic.

(type: bool)

_initialized = (source)

Whether the stream represented by xmlstream has been initialized. This is used when caching outgoing stanzas.

(type: bool)

_packetQueue = (source)

internal buffer of unsent data. See send for details.

(type: list)

def __init__(self, factory): (source)

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

Undocumented

factory = (source)

Undocumented

def addHandler(self, handler): (source)

from twisted.words.protocols.jabber.ijabber.IXMPPHandlerCollection

overrides twisted.words.protocols.jabber.xmlstream.XMPPHandlerCollection.addHandler

Add protocol handler.

When an XML stream has already been established, the handler's connectionInitialized will be called to get it up to speed.

def _connected(self, xs): (source)

Called when the transport connection has been established.

Here we optionally set up traffic logging (depending on logTraffic) and call each handler's makeConnection method with the XmlStream instance.

def _authd(self, xs): (source)

Called when the stream has been initialized.

Send out cached stanzas and call each handler's connectionInitialized method.

def initializationFailed(self, reason): (source)

Called when stream initialization has failed.

Stream initialization has halted, with the reason indicated by reason. It may be retried by calling the authenticator's initializeStream. See the respective authenticators for details.

Parameters reason A failure instance indicating why stream initialization failed. (type: failure.Failure)

def _disconnected(self, reason): (source)

Called when the stream has been closed.

From this point on, the manager doesn't interact with the XmlStream anymore and notifies each handler that the connection was lost by calling its connectionLost method.

def send(self, obj): (source)

Send data over the XML stream.

When there is no established XML stream, the data is queued and sent out when a new XML stream has been established and initialized.

Parameters obj data to be sent over the XML stream. See xmlstream.XmlStream.send for details.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.