2020-08-21 15:59:24 +02:00
lightning-ping -- Command to check if a node is up.
============================================================
SYNOPSIS
--------
2022-01-26 18:18:49 +01:00
**ping** *id* [*len*] [*pongbytes*]
2020-08-21 15:59:24 +02:00
DESCRIPTION
-----------
2021-10-09 07:53:29 +02:00
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:
2020-08-21 15:59:24 +02:00
2020-09-07 12:46:28 +02:00
- *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).
2021-10-09 07:53:29 +02:00
A value of 65532 to 65535 means "don't reply".
2020-08-21 15:59:24 +02:00
EXAMPLE JSON REQUEST
------------
```json
{
"id": 82,
"method": "ping",
"params": {
"len": 128,
"pongbytes": 128
}
}
```
RETURN VALUE
------------
2021-06-16 03:10:17 +02:00
[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)
2021-09-03 12:07:59 +02:00
2021-06-16 03:10:17 +02:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
2020-08-21 15:59:24 +02:00
On failure, one of the following error codes may be returned:
2020-08-31 14:42:28 +02:00
2021-10-09 07:53:29 +02:00
- -32602: Error in given parameters or we're already waiting for a ping response from peer.
2020-08-21 15:59:24 +02:00
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 >
2022-07-13 17:45:39 +02:00
[comment]: # ( SHA256STAMP:59da52931ba9cb4c192ab81973efed2246baa9a97aded29e2c4cf280972c9a9a)
