mirrors/core-lightning
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2025-03-03 10:46:58 +01:00
Code Issues Projects Releases Wiki Activity

libplugin: expose helpers to start and end a jsonrpc response

Browse source 
The usual json_stream starters and command_result enders.
This commit is contained in:
darosior 2020-01-28 12:28:25 +01:00 • committed by Rusty Russell
parent 9521549c49
commit 45e9f53c6b
2 changed files with 59 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
plugins/libplugin.c
View file

@ -150,6 +150,37 @@ static struct json_stream *jsonrpc_stream_start(struct command *cmd)
return js; return js;
} }
struct json_stream *jsonrpc_stream_success(struct command *cmd)
{
struct json_stream *js = jsonrpc_stream_start(cmd);
json_object_start(js, "result");
return js;
}
struct json_stream *jsonrpc_stream_fail(struct command *cmd,
int code,
const char *err)
{
struct json_stream *js = jsonrpc_stream_start(cmd);
json_object_start(js, "error");
json_add_member(js, "code", false, "%d", code);
json_add_string(js, "message", err);
return js;
}
struct json_stream *jsonrpc_stream_fail_data(struct command *cmd,
int code,
const char *err)
{
struct json_stream *js = jsonrpc_stream_fail(cmd, code, err);
json_object_start(js, "data");
return js;
}
static struct command_result *command_complete(struct command *cmd, static struct command_result *command_complete(struct command *cmd,
struct json_stream *result) struct json_stream *result)
{ {
@ -162,6 +193,15 @@ static struct command_result *command_complete(struct command *cmd,
return &complete; return &complete;
} }
struct command_result *WARN_UNUSED_RESULT
command_finished(struct command *cmd, struct json_stream *response)
{
/* "result" or "error" object */
json_object_end(response);
return command_complete(cmd, response);
}
struct json_out *json_out_obj(const tal_t *ctx, struct json_out *json_out_obj(const tal_t *ctx,
const char *fieldname, const char *fieldname,
const char *str) const char *str)

19
plugins/libplugin.h
View file

@ -70,6 +70,25 @@ struct plugin_hook {
const jsmntok_t *params); const jsmntok_t *params);
}; };
/* Helper to create a JSONRPC2 response stream with a "result" object. */
struct json_stream *jsonrpc_stream_success(struct command *cmd);
/* Helper to create a JSONRPC2 response stream with an "error" object. */
struct json_stream *jsonrpc_stream_fail(struct command *cmd,
int code,
const char *err);
/* Helper to create a JSONRPC2 response stream with an "error" object,
* to which will be added a "data" object. */
struct json_stream *jsonrpc_stream_fail_data(struct command *cmd,
int code,
const char *err);
/* This command is finished, here's the response (the content of the
* "result" or "error" field) */
struct command_result *WARN_UNUSED_RESULT
command_finished(struct command *cmd, struct json_stream *response);
/* Helper to create a zero or single-value JSON object; if @str is NULL, /* Helper to create a zero or single-value JSON object; if @str is NULL,
* object is empty. */ * object is empty. */
struct json_out *json_out_obj(const tal_t *ctx, struct json_out *json_out_obj(const tal_t *ctx,