XEP 0199¶

class slixmpp.plugins.xep_0199.XEP_0199(xmpp, config=None)[source]¶

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)[source]¶

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)[source]¶

Send a ping request.

Parameters

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

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