mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-20 10:39:49 +01:00
Code Issues Projects Releases Wiki Activity
4c370022d0
core-lightning/doc/lightning-ping.7.md

73 lines
1.3 KiB
Markdown
Raw 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 15:59:24 +02:00
lightning-ping -- Command to check if a node is up.
============================================================
SYNOPSIS
--------
Remove useless \
2022-01-26 18:18:49 +01: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 15:59:24 +02: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 08:10:12 +01: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 07:53:29 +02:00
It currently only works for peers we have a channel with.
Start ping command and fix some convention in other new doc file Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-21 15:59:24 +02:00
EXAMPLE JSON REQUEST
------------
doc: Markdown cleanup This commit will remove parameter descriptions from RPC markdown but we will fix it in next commits by reading these descriptions directly from json. - Removing parameter description text - Adding/removing newlines for cleaner formatting - Adding ERRORS title wherever needed - Updating titles for consistency - Adding resources links
2024-02-02 05:50:25 +01:00
Start ping command and fix some convention in other new doc file Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-21 15:59:24 +02:00
```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 03:10:17 +02: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 23:33:09 +02: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 03:10:17 +02: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 12:07:59 +02: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 03:10:17 +02: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 15:59:24 +02:00
doc: Markdown cleanup This commit will remove parameter descriptions from RPC markdown but we will fix it in next commits by reading these descriptions directly from json. - Removing parameter description text - Adding/removing newlines for cleaner formatting - Adding ERRORS title wherever needed - Updating titles for consistency - Adding resources links
2024-02-02 05:50:25 +01:00
ERRORS
------
Start ping command and fix some convention in other new doc file Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-21 15:59:24 +02: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 14:42:28 +02: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 07:53:29 +02: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 15:59:24 +02:00
EXAMPLE JSON RESPONSE
-----
doc: Markdown cleanup This commit will remove parameter descriptions from RPC markdown but we will fix it in next commits by reading these descriptions directly from json. - Removing parameter description text - Adding/removing newlines for cleaner formatting - Adding ERRORS title wherever needed - Updating titles for consistency - Adding resources links
2024-02-02 05:50:25 +01:00
Start ping command and fix some convention in other new doc file Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2020-08-21 15:59:24 +02:00
```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 08:10:12 +01:00
schemas: deprecated is now a range. Don't assume removal is +6 months, but have a start deprecation/end support range. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
2024-01-25 01:28:53 +01:00
[comment]: # ( SHA256STAMP:3d65bfe95b32d6f1229fcf9215045516ff04e670de8ba0485e585d699e1b1f71)
Reference in New Issue Copy Permalink