class twisted.words.protocols.jabber.xmlstream.XmlStream(xmlstream.XmlStream): (source)
XMPP XML Stream protocol handler.
| Instance Variable | version | XML stream version as a tuple (major, minor). Initially, this is set to the minimally supported version. Upon receiving the stream header of the peer, it is set to the minimum of that value and the version on the received header. |
| Instance Variable | namespace | default namespace URI for stream |
| Instance Variable | thisEntity | JID of this entity |
| Instance Variable | otherEntity | JID of the peer entity |
| Instance Variable | sid | session identifier |
| Instance Variable | initiating | True if this is the initiating stream |
| Instance Variable | features | map of (uri, name) to stream features element received from the receiving entity. |
| Instance Variable | prefixes | map of URI to prefixes that are to appear on stream header. |
| Instance Variable | initializers | list of stream initializer objects |
| Instance Variable | authenticator | associated authenticator that uses initializers to initialize the XML stream. |
| Method | __init__ | Undocumented |
| Method | reset | Reset XML Stream. |
| Method | onStreamError | Called when a stream:error element has been received. |
| Method | sendHeader | Send stream header. |
| Method | sendFooter | Send stream footer. |
| Method | sendStreamError | Send stream level error. |
| Method | send | Send data over the stream. |
| Method | connectionMade | Called when a connection is made. |
| Method | onDocumentStart | Called when the stream header has been received. |
| Instance Variable | _headerSent | Undocumented |
| Method | _callLater | Undocumented |
Inherited from XmlStream:
| Instance Variable | stream | Undocumented |
| Instance Variable | rawDataOutFn | Undocumented |
| Instance Variable | rawDataInFn | Undocumented |
| Method | dataReceived | Called whenever data is received. |
| Method | connectionLost | Called when the connection is shut down. |
| Method | onElement | Called whenever a direct child element of the root element has been received. |
| Method | onDocumentEnd | Called whenever the end tag of the root element has been received. |
| Method | setDispatchFn | Set another function to handle elements. |
| Method | resetDispatchFn | Set the default function (onElement) to handle elements. |
| Method | _initializeStream | Sets up XML Parser. |
Inherited from Protocol (via XmlStream):
| Class Variable | factory | Undocumented |
| Method | logPrefix | Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Inherited from BaseProtocol (via XmlStream, Protocol):
| Instance Variable | connected | Undocumented |
| Instance Variable | transport | Undocumented |
| Method | makeConnection | Make a connection to a transport and a server. |
Inherited from EventDispatcher (via XmlStream):
| Instance Variable | prefix | Undocumented |
| Method | addOnetimeObserver | Register a one-time observer for an event. |
| Method | addObserver | Register an observer for an event. |
| Method | removeObserver | Remove callable as observer for an event. |
| Method | dispatch | Dispatch an event. |
| Instance Variable | _eventObservers | Undocumented |
| Instance Variable | _xpathObservers | Undocumented |
| Instance Variable | _dispatchDepth | Undocumented |
| Instance Variable | _updateQueue | Undocumented |
| Method | _getEventAndObservers | Undocumented |
| Method | _addObserver | Undocumented |
int, int))
dict of (unicode, unicode) to domish.Element.)
dict of unicode to unicode)
initializers to initialize the XML stream.Reset XML Stream.
Resets the XML Parser for incoming data. This is to be used after successfully negotiating a new layer, e.g. TLS and SASL. Note that registered event observers will continue to be in place.
Called when a stream:error element has been received.
Dispatches a STREAM_ERROR_EVENT event with the error element to allow for cleanup actions and drops the connection.
| Parameters | errelem | The received error element. (type: domish.Element) |
Send stream level error.
If we are the receiving entity, and haven't sent the header yet, we sent one first.
After sending the stream error, the stream is closed and the transport connection dropped.
| Parameters | streamError | stream error instance (type: error.StreamError) |
Send data over the stream.
This overrides xmlstream.XmlStream.send to use the default namespace of the stream header when serializing domish.IElements. It is assumed that if you pass an object that provides domish.IElement, it represents a direct child of the stream's root element.
Called when a connection is made.
Notifies the authenticator when a connection has been made.
Called when the stream header has been received.
Extracts the header's id and version attributes from the root element. The id attribute is stored in our sid attribute and the version attribute is parsed and the minimum of the version we sent and the parsed version attribute is stored as a tuple (major, minor) in this class' version attribute. If no version attribute was present, we assume version 0.0.
If appropriate (we are the initiating stream and the minimum of our and the other party's version is at least 1.0), a one-time observer is registered for getting the stream features. The registered function is onFeatures.
Ultimately, the authenticator's streamStarted method will be called.
| Parameters | rootElement | The root element. (type: domish.Element) |