mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-12-27 09:04:40 +01:00
ba7d4a8f6b
We were including the entire list of prerequisites when generating a shastamp, which for schemas includes the `tools/fromschema.py` doc. This meant all of our shasums were updating anytime this tool file changed. Instead, we just include the first prerequisite. See: https://www.gnu.org/software/make/manual/html_node/Automatic-Variables.html#Automatic-Variables
1.6 KiB
1.6 KiB
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.
SEE ALSO
lightning-connect(7)
RESOURCES
Main web site: https://github.com/ElementsProject/lightning comment: # ( SHA256STAMP:59da52931ba9cb4c192ab81973efed2246baa9a97aded29e2c4cf280972c9a9a)