wokkel.subprotocolsView Source (View In Hierarchy)
|Instance Variable||xmlstream||currently managed XML stream (type:
|Instance Variable||logTraffic||if true, log all traffic. (type:
|Instance Variable||timeout||Default IQ request timeout in seconds. (type:
|Method||__init__||Construct a stream manager.|
|Method||addHandler||Add protocol handler.|
|Method||initializationFailed||Called when stream initialization has failed.|
|Method||send||Send data over the XML stream.|
|Method||request||Send an IQ request and track the response.|
|Instance Variable||_initialized||Whether the stream represented by
|Instance Variable||_packetQueue||internal buffer of unsent data. See
|Instance Variable||_reactor||A provider of
|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.|
|Method||_onIQResponse||Handle iq response by firing associated deferred.|
Inherited from XMPPHandlerCollection:
|Instance Variable||handlers||List of protocol handlers. (type:
|Method||__iter__||Act as a container for handlers.|
|Method||removeHandler||Remove protocol handler.|
xmlstreamhas been initialized. This is used when caching outgoing stanzas. (type:
Construct a stream manager.
|Parameters||factory||The stream factory to connect with.|
|reactor||A provider of |
Add protocol handler.
When an XML stream has already been established, the handler's
connectionInitialized will be called to get it up to
Called when the transport connection has been established.
Here we optionally set up traffic logging (depending on
and call each handler's
makeConnection method with the
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
|Parameters||reason||A failure instance indicating why stream initialization failed. (type: |
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
Handle iq response by firing associated deferred.
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 |
Send an IQ request and track the response.
A request is an IQ
generic.Stanza of type
'set'. It will have its
toElement called to render to a
which is then sent out over the current stream. If there is no such stream
(yet), it is queued and sent whenever a connection is established and
initialized, just like
If the request doesn't have an identifier, it will be assigned a fresh one, so the response can be tracked.
If the connection is closed before a response was received, the deferred will be errbacked with the reason failure.
A request may also have a timeout, either by setting a default timeout
timeout attribute or on the
timeout attribute of
|Parameters||request||The IQ request. (type: |