view doc/jp/ping.rst @ 3123:130f9cb6e0ab

core (memory/params): added `extra` argument to filter out params notably in `getParamsUI`: In some case, it may be desirable for a frontend to not expose some parameters to user (e.g. it is the case on Android with the `autoconnect_backend` parameter). An new `extra` parameter has been added to a couple of parameters method for that: it can contain the `ignore` key with a list of [category, name] of parameters to skip.
author Goffi <goffi@goffi.org>
date Sat, 25 Jan 2020 21:08:40 +0100
parents 72583524cfd3
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::

  $ jp ping example.org