mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 18:11:28 +01:00
eb6b8551d4
We only handle top-level objects with an array of objects: make sure it is one before we call the routines. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
75 lines
1.6 KiB
Markdown
75 lines
1.6 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 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
|
|
------------
|
|
```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 we're already waiting for a ping response from 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:7fe1120c251ffe6d51057a94823376a512dee3ec4f251be82a7dc4b2f044a165)
|