view doc/libervia-cli/ping.rst @ 3960:4836b81c5f31

plugin XEP-0373: minor renaming + set `gpg_provider` in client: - `sat` and `self.__sat` have been renamed to `host` and `self.host` for consistency with other plugins. - `gpg_provider` is set in client while profile is connecting, so the instance is easily accessible to plugins depending on XEP-0373 rel 381
author Goffi <goffi@goffi.org>
date Sun, 30 Oct 2022 01:06:32 +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