XEP-0199: XMPP Ping

class slixmpp.plugins.xep_0199.XEP_0199(xmpp, config=None)

XEP-0199: XMPP Ping

Given that XMPP is based on TCP connections, it is possible for the underlying connection to be terminated without the application’s awareness. Ping stanzas provide an alternative to whitespace based keepalive methods for detecting lost connections.

Also see <http://www.xmpp.org/extensions/xep-0199.html>.

Attributes:

keepalive – If True, periodically send ping requests

to the server. If a ping is not answered, the connection will be reset.

interval – Time in seconds between keepalive pings.

Defaults to 300 seconds.

timeout – Time in seconds to wait for a ping response.

Defaults to 30 seconds.

Methods:

send_ping – Send a ping to a given JID, returning the

round trip time.

async ping(jid=None, ifrom=None, timeout=None)

Send a ping request and calculate RTT. This is a coroutine.

Parameters

jid (Optional[JID]) – The JID that will receive the ping.

Return type

float

send_ping(jid, ifrom=None, timeout=None, callback=None, timeout_callback=None)

Send a ping request.

Parameters

jid (JID) – The JID that will receive the ping.

Stanza elements

class slixmpp.plugins.xep_0199.stanza.Ping(xml=None, parent=None)

Given that XMPP is based on TCP connections, it is possible for the underlying connection to be terminated without the application’s awareness. Ping stanzas provide an alternative to whitespace based keepalive methods for detecting lost connections.

Example ping stanza:

<iq type="get">
  <ping xmlns="urn:xmpp:ping" />
</iq>

interfaces: ClassVar[Set[str]] = {}

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.

iterables: List[ElementBase]

A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]

name: ClassVar[str] = 'ping'

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

namespace: str = 'urn:xmpp:ping'

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.

parent: Optional[ReferenceType[ElementBase]]

A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

plugin_attrib: ClassVar[str] = 'ping'

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']

plugins: Dict[Tuple[str, Optional[str]], ElementBase]

An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

tag: str

The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element

The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.