Mercurial > libervia-backend

view doc/libervia-cli/ping.rst @ 3677:02e5e2385a30

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
component (file-sharing): use `file-sharing` instead of `file_sharing`: a dash is used instead of underscore for entry-point and config section., as it is best practice to use dash on command-line.
author Goffi <goffi@goffi.org>
date Sun, 26 Sep 2021 16:35:56 +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