mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 09:54:16 +01:00
Code Issues Projects Releases Wiki Activity

param: updated comments in the spirit of #1899

Browse Source 
Signed-off-by: Mark Beckwith <wythe@intrig.com>
This commit is contained in:
Mark Beckwith 2018-08-30 14:11:27 -05:00 committed by Rusty Russell
parent 30e6471fc1
commit 4ad16b67f1
1 changed files with 27 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
lightningd/param.h
View File

@ -2,26 +2,33 @@
#define LIGHTNING_LIGHTNINGD_PARAM_H
#include "config.h"
/*
Typesafe callback system for unmarshalling and validating json parameters.
Typical usage:
unsigned *cltv;
u64 *msatoshi;
const jsmntok_t *note;
u64 *expiry;
if (!param(cmd, buffer, params,
p_req("cltv", json_tok_number, &cltv),
p_opt("msatoshi", json_tok_u64, &msatoshi),
p_opt_tok("note", &note),
p_opt_def("expiry", json_tok_u64, &expiry, 3600),
NULL))
return;
See json_invoice() for a good example. The common callbacks can be found in
lightningd/json.c. Use them as an example for writing your own custom
callbacks.
/*~ Greetings adventurer!
*
* Do you want to automatically validate json input and unmarshall it into
* local variables, all using typesafe callbacks? And on error,
* call command_fail with a proper error message? Then you've come to the
* right place!
*
* Here is a simple example of using the system:
*
* unsigned *cltv;
* u64 *msatoshi;
* const jsmntok_t *note;
* u64 *expiry;
*
* if (!param(cmd, buffer, params,
* p_req("cltv", json_tok_number, &cltv),
* p_opt("msatoshi", json_tok_u64, &msatoshi),
* p_opt("note", json_tok_tok, &note),
* p_opt_def("expiry", json_tok_u64, &expiry, 3600),
* NULL))
* return;
*
* If param() returns true then you're good to go.
*
* All the command handlers throughout the code use this system.
* json_invoice() is a great example. The common callbacks can be found in
* lightningd/json.c. Use them directly or feel free to write your own.
*/
/*