XEP 0198¶

class slixmpp.plugins.xep_0198.XEP_0198(xmpp, config=None)[source]¶

XEP-0198: Stream Management

disconnected(event)[source]¶: Reset enabled state until we can resume/reenable.

request_ack(e=None)[source]¶: Request an ack from the server.

send_ack()[source]¶: Send the current ack count to the server.

session_end(event)[source]¶: Reset stream management state.

stanza = <module 'slixmpp.plugins.xep_0198.stanza' from '/home/docs/checkouts/readthedocs.org/user_builds/slixmpp/checkouts/slix-1.7.1/slixmpp/plugins/xep_0198/stanza.py'>¶

Stanza elements¶

See the file LICENSE for copying permission.

class slixmpp.plugins.xep_0198.stanza.Ack(stream=None, xml=None, stype=None, sto=None, sfrom=None, sid=None, parent=None)[source]¶

get_h()[source]¶

interfaces = {'h'}¶: The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

name = 'a'¶: The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace = 'urn:xmpp:sm:3'¶: The default XMPP client namespace

set_h(val)[source]¶

setup(xml)[source]¶

Initialize the stanza’s XML contents.

Will return True if XML was generated according to the stanza’s definition instead of building a stanza object from an existing XML object.

Parameters: xml – An existing XML object to use for the stanza’s content instead of generating new XML.

class slixmpp.plugins.xep_0198.stanza.Enable(stream=None, xml=None, stype=None, sto=None, sfrom=None, sid=None, parent=None)[source]¶

get_resume()[source]¶

interfaces = {'max', 'resume'}¶: The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

name = 'enable'¶: The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace = 'urn:xmpp:sm:3'¶: The default XMPP client namespace

set_resume(val)[source]¶

setup(xml)[source]¶

Initialize the stanza’s XML contents.

Will return True if XML was generated according to the stanza’s definition instead of building a stanza object from an existing XML object.

Parameters: xml – An existing XML object to use for the stanza’s content instead of generating new XML.

class slixmpp.plugins.xep_0198.stanza.Enabled(stream=None, xml=None, stype=None, sto=None, sfrom=None, sid=None, parent=None)[source]¶

get_resume()[source]¶

interfaces = {'id', 'location', 'max', 'resume'}¶: The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

name = 'enabled'¶: The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace = 'urn:xmpp:sm:3'¶: The default XMPP client namespace

set_resume(val)[source]¶

setup(xml)[source]¶

Initialize the stanza’s XML contents.

Will return True if XML was generated according to the stanza’s definition instead of building a stanza object from an existing XML object.

Parameters: xml – An existing XML object to use for the stanza’s content instead of generating new XML.

class slixmpp.plugins.xep_0198.stanza.Failed(stream=None, xml=None, stype=None, sto=None, sfrom=None, sid=None, parent=None)[source]¶

interfaces = {}¶: The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

name = 'failed'¶: The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace = 'urn:xmpp:sm:3'¶: The default XMPP client namespace

setup(xml)[source]¶

Initialize the stanza’s XML contents.

Will return True if XML was generated according to the stanza’s definition instead of building a stanza object from an existing XML object.

Parameters: xml – An existing XML object to use for the stanza’s content instead of generating new XML.

class slixmpp.plugins.xep_0198.stanza.RequestAck(stream=None, xml=None, stype=None, sto=None, sfrom=None, sid=None, parent=None)[source]¶

interfaces = {}¶: The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

name = 'r'¶: The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace = 'urn:xmpp:sm:3'¶: The default XMPP client namespace

setup(xml)[source]¶

Initialize the stanza’s XML contents.

Will return True if XML was generated according to the stanza’s definition instead of building a stanza object from an existing XML object.

Parameters: xml – An existing XML object to use for the stanza’s content instead of generating new XML.

class slixmpp.plugins.xep_0198.stanza.Resume(stream=None, xml=None, stype=None, sto=None, sfrom=None, sid=None, parent=None)[source]¶

get_h()[source]¶

interfaces = {'h', 'previd'}¶: The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

name = 'resume'¶: The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace = 'urn:xmpp:sm:3'¶: The default XMPP client namespace

set_h(val)[source]¶

setup(xml)[source]¶

Initialize the stanza’s XML contents.

Will return True if XML was generated according to the stanza’s definition instead of building a stanza object from an existing XML object.

Parameters: xml – An existing XML object to use for the stanza’s content instead of generating new XML.

class slixmpp.plugins.xep_0198.stanza.Resumed(stream=None, xml=None, stype=None, sto=None, sfrom=None, sid=None, parent=None)[source]¶

get_h()[source]¶

interfaces = {'h', 'previd'}¶: The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

name = 'resumed'¶: The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace = 'urn:xmpp:sm:3'¶: The default XMPP client namespace

set_h(val)[source]¶

setup(xml)[source]¶

Initialize the stanza’s XML contents.

Will return True if XML was generated according to the stanza’s definition instead of building a stanza object from an existing XML object.

Parameters: xml – An existing XML object to use for the stanza’s content instead of generating new XML.

class slixmpp.plugins.xep_0198.stanza.StreamManagement(xml=None, parent=None)[source]¶

del_optional()[source]¶

del_required()[source]¶

get_optional()[source]¶

get_required()[source]¶

interfaces = {'optional', 'required'}¶: The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

name = 'sm'¶: The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace = 'urn:xmpp:sm:3'¶: The XML namespace for the element. Given <foo xmlns="bar" />, then namespace = "bar" should be used. The default namespace is jabber:client since this is being used in an XMPP library.

plugin_attrib = 'sm'¶

For ElementBase subclasses which are intended to be used as plugins, the plugin_attrib value defines the plugin name. Plugins may be accessed by using the plugin_attrib value as the interface. An example using plugin_attrib = 'foo':

register_stanza_plugin(Message, FooPlugin)
msg = Message()
msg['foo']['an_interface_from_the_foo_plugin']

set_optional(val)[source]¶

set_required(val)[source]¶

XEP 0198

1.7 Documentation

XEP 0198¶

Stanza elements¶