ping
— XMPP Ping (XEP-0199)¶
XMPP Ping is a ping on the XMPP protocol level. It can be used to detect
connection liveness (although aioxmpp.stream.StanzaStream
and thus
aioxmpp.Client
does that for you) and connectivity/availablility of
remote domains.
Service¶
-
class
aioxmpp.
PingService
[source]¶ Service implementing XMPP Ping (XEP-0199).
This service implements the response to XMPP Pings and provides a method to send pings.
-
coroutine
ping
(peer)[source]¶ Ping a peer.
Parameters: peer ( aioxmpp.JID
) – The peer to ping.Raises: aioxmpp.errors.XMPPError – as received Send a XEP-0199 ping IQ to peer and wait for the reply.
Note
If the peer does not support XEP-0199, they will respond with a
cancel
service-unavailable
error. However, some implementations return acancel
feature-not-implemented
error instead. Callers should be prepared for theaioxmpp.XMPPCancelError
exceptions in those cases.
-
coroutine