mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 18:11:28 +01:00

Simon Vrouwe 3c8ec25a6f dox: fix "sphinx-build -b html" warning: reference target not found

when runnning `sphinx-build -b html . build/`:
WARNING: None:any reference target not found: #

2022-12-19 19:00:39 +01:00

1.6 KiB

Raw Blame History

lightning-ping -- Command to check if a node is up.

SYNOPSIS

ping id [len] [pongbytes]

DESCRIPTION

The ping command checks if the node with id is ready to talk. It currently only works for peers we have a channel with.

It accepts the following parameters:

id: A string that represents the node id;
len: A integer that represents the length of the ping (default 128);
pongbytes: An integer that represents the length of the reply (default 128). A value of 65532 to 65535 means "don't reply".

EXAMPLE JSON REQUEST

{
  "id": 82,
  "method": "ping",
  "params": {
    "len": 128,
    "pongbytes": 128
  }
}

RETURN VALUE

On success, an object is returned, containing:

totlen (u16): the answer length of the reply message (including header: 0 means no reply expected)

On failure, one of the following error codes may be returned:

-32602: Error in given parameters or we're already waiting for a ping response from peer.

EXAMPLE JSON RESPONSE

{
   "totlen": 132
}

AUTHOR

Vincenzo Palazzo <vincenzo.palazzo@protonmail.com> wrote the initial version of this man page, but many others did the hard work of actually implementing this rpc command.

RESOURCES

Main web site: https://github.com/ElementsProject/lightning

1.6 KiB Raw Blame History