vincenzopalazzo
/
rgb-cln
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity
rgb-cln/doc/lightning-ping.7.md

75 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

Start ping command and fix some convention in other new doc file Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-21 14:59:24 +01:00
lightning-ping -- Command to check if a node is up.
============================================================
SYNOPSIS
--------
Remove useless \
2022-01-26 17:18:49 +00:00
**ping** *id* [*len*] [*pongbytes*]
Start ping command and fix some convention in other new doc file Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-21 14:59:24 +01:00
DESCRIPTION
-----------
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-09 07:10:12 +00:00
The **ping** command checks if the node with *id* is ready to talk.
channeld: restore ping command, but only for channeld. It's probably not worth fixing for the other daemons. Changelog-Changed: JSON-RPC: `ping` now only works if we have a channel with the peer. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-10-09 06:53:29 +01:00
It currently only works for peers we have a channel with.
It accepts the following parameters:
Start ping command and fix some convention in other new doc file Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-21 14:59:24 +01:00
doc: language tidyups and a few minor refinements. Some additional detail was warranted in several places, though the listconfigs is better off simply referring to lightningd-config. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> Changelog-Fixed: doc: Many missing manual pages were completed
2020-09-07 11:46:28 +01: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).
channeld: restore ping command, but only for channeld. It's probably not worth fixing for the other daemons. Changelog-Changed: JSON-RPC: `ping` now only works if we have a channel with the peer. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-10-09 06:53:29 +01:00
A value of 65532 to 65535 means "don't reply".
Start ping command and fix some convention in other new doc file Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-21 14:59:24 +01:00
EXAMPLE JSON REQUEST
------------
```json
{
"id": 82,
"method": "ping",
"params": {
"len": 128,
"pongbytes": 128
}
}
```
RETURN VALUE
------------
doc: schemas for everything else. 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.
2021-06-16 02:10:17 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-START)
On success, an object is returned, containing:
doc: generate correct markdown from schemas. You can't start a list without a paragraph separator. ```diff --- /tmp/before 2022-07-20 22:02:23.485372596 +0930 +++ /tmp/after 2022-07-20 22:02:33.745528456 +0930 @@ -21,12 +21,16 @@ On startup of the daemon, no autoclean is set up. RETURN VALUE - On success, an object is returned, containing: - enabled (boolean): - whether invoice autocleaning is active + On success, an object is returned, containing: - If enabled is true: - expired_by (u64): how long an invoice must be ex‐ - pired (seconds) before we delete it - cycle_seconds (u64): how long an - invoice must be expired (seconds) before we delete it + • enabled (boolean): whether invoice autocleaning is active + + If enabled is true: + + • expired_by (u64): how long an invoice must be expired (seconds) be‐ + fore we delete it + • cycle_seconds (u64): how long an invoice must be expired (seconds) + before we delete it AUTHOR ZmnSCPxj <ZmnSCPxj@protonmail.com> is mainly responsible. ``` Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2022-09-05 22:33:09 +01:00
doc: schemas for everything else. 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.
2021-06-16 02:10:17 +01:00
- **totlen** (u16): the answer length of the reply message (including header: 0 means no reply expected)
doc: fix GH/readthedocs rendering of manual pages. They render the comment as if it's in the list. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-09-03 11:07:59 +01:00
doc: schemas for everything else. 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.
2021-06-16 02:10:17 +01:00
[comment]: # (GENERATE-FROM-SCHEMA-END)
Start ping command and fix some convention in other new doc file Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-21 14:59:24 +01:00
On failure, one of the following error codes may be returned:
Fixed mistake inside the docs Thanks @rustyrussell. Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-31 13:42:28 +01:00
channeld: restore ping command, but only for channeld. It's probably not worth fixing for the other daemons. Changelog-Changed: JSON-RPC: `ping` now only works if we have a channel with the peer. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2021-10-09 06:53:29 +01:00
- -32602: Error in given parameters or we're already waiting for a ping response from peer.
Start ping command and fix some convention in other new doc file Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-21 14:59:24 +01: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>
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-09 07:10:12 +00:00
tools/fromschema.py: don't try to handle more complex cases. 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>
2023-01-30 06:24:16 +00:00
[comment]: # ( SHA256STAMP:7fe1120c251ffe6d51057a94823376a512dee3ec4f251be82a7dc4b2f044a165)