view doc/libervia-cli/ping.rst @ 3899:1e64f1ed3ebd

plugin XEP-0060: raise an `NotFound` exception instead of StanzaError in `subscribe`: `exceptions.NotFound` is now raised in stead of `item-not-found` `StanzaError` for consistency with `getItems` and because it's easier to catch (condition has to be checked when `StanzaError` is received). rel 372
author Goffi <goffi@goffi.org>
date Wed, 21 Sep 2022 22:32:36 +0200
parents c80a0f864b5d
children
line wrap: on
line source

=========================================
ping: get response time of an XMPP entity
=========================================

``ping`` is more or less the equivalent of the command of the same name on most OSes, but
for XMPP. It send a `XEP-0199`_ PING and wait for the answer. When (and if) received, the
time to receive the answer is shown, else the time to receive the error message is shown.
This can be helpful to quickly test the connection with the server or a device.

If you need to get only the response time (without text around), you may use ``-d,
--delay-only``.

.. _XEP-0199: https://xmpp.org/extensions/xep-0199.html

example
-------

Get reponse time of a server::

  $ li ping example.org