mirror of
https://github.com/ElementsProject/lightning.git
synced 2025-01-04 04:54:47 +01:00
2ddecdc95a
Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Epic documentation rewrite: each now lists complete and accurate JSON output, tested against testsuite.
68 lines
1.5 KiB
Markdown
68 lines
1.5 KiB
Markdown
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 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).
|
|
|
|
EXAMPLE JSON REQUEST
|
|
------------
|
|
```json
|
|
{
|
|
"id": 82,
|
|
"method": "ping",
|
|
"params": {
|
|
"len": 128,
|
|
"pongbytes": 128
|
|
}
|
|
}
|
|
```
|
|
|
|
RETURN VALUE
|
|
------------
|
|
|
|
[comment]: # (GENERATE-FROM-SCHEMA-START)
|
|
On success, an object is returned, containing:
|
|
- **totlen** (u16): the answer length of the reply message (including header: 0 means no reply expected)
|
|
[comment]: # (GENERATE-FROM-SCHEMA-END)
|
|
|
|
On failure, one of the following error codes may be returned:
|
|
|
|
- -32602: Error in given parameters or unknown peer.
|
|
|
|
EXAMPLE JSON RESPONSE
|
|
-----
|
|
```json
|
|
{
|
|
"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:56bf89ba67c8e1db1bf3c2cf793d59eecd0c5c23012ffb66fe3f8fa8f7d9007c)
|