lukechilds
/
lightning
mirror of https://github.com/lukechilds/lightning.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
5186 Commits
55 Branches
107 Tags
38 MiB
Tree: 14716f21ab
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '14716f21ab'
${ noResults }
lightning/common/json_command.h

27 lines
881 B
Raw Normal View History

param: abstract 'struct command' so param doesn't need to access it. I want to use param functions in plugins, and they don't have struct command. I had to use a special arg to param() for check to flag it as allowing extra parameters, rather than adding a one-use accessor. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au>
6 years ago
/* These functions must be supplied by any binary linking with common/param
* so it can fail commands. */
#ifndef LIGHTNING_COMMON_JSON_COMMAND_H
#define LIGHTNING_COMMON_JSON_COMMAND_H
#include "config.h"
#include <ccan/compiler/compiler.h>
#include <stdbool.h>
struct command;
param: make command sinks (fail/success) return a special type. These routines free the &#39;struct command&#39;: a common coding error is not to return immediately. To catch this, we make them return a non-NULL &#39;struct command_result *&#39;, and we&#39;re going to make the command handlers return the same (to encourage &#39;return command_fail(...)&#39;-style usage). We also provide two sources for external use: 1. command_param_failed() when param() fails. 2. command_its_complicated() for some complex cases. Signed-off-by: Rusty Russell &lt;rusty@rustcorp.com.au&gt;
6 years ago
struct command_result;
param: abstract &#39;struct command&#39; so param doesn&#39;t need to access it. I want to use param functions in plugins, and they don&#39;t have struct command. I had to use a special arg to param() for check to flag it as allowing extra parameters, rather than adding a one-use accessor. Signed-off-by: Rusty Russell &lt;rusty@rustcorp.com.au&gt;
6 years ago
/* Caller supplied this: param assumes it can call it. */
param: make command sinks (fail/success) return a special type. These routines free the &#39;struct command&#39;: a common coding error is not to return immediately. To catch this, we make them return a non-NULL &#39;struct command_result *&#39;, and we&#39;re going to make the command handlers return the same (to encourage &#39;return command_fail(...)&#39;-style usage). We also provide two sources for external use: 1. command_param_failed() when param() fails. 2. command_its_complicated() for some complex cases. Signed-off-by: Rusty Russell &lt;rusty@rustcorp.com.au&gt;
6 years ago
struct command_result *command_fail(struct command *cmd, int code,
const char *fmt, ...)
param: make command_fail/command_success WARN_UNUSED_RESULT. This causes a compiler warning if we don&#39;t do something with the result (hopefully return immediately!). We use was_pending() to ignore the result in the case where we complete a command in a callback (thus really do want to ignore the result). This actually fixes one bug: we didn&#39;t return after command_fail in json_getroute with a bad seed value. Signed-off-by: Rusty Russell &lt;rusty@rustcorp.com.au&gt;
6 years ago
PRINTF_FMT(3, 4) WARN_UNUSED_RESULT;
param: abstract &#39;struct command&#39; so param doesn&#39;t need to access it. I want to use param functions in plugins, and they don&#39;t have struct command. I had to use a special arg to param() for check to flag it as allowing extra parameters, rather than adding a one-use accessor. Signed-off-by: Rusty Russell &lt;rusty@rustcorp.com.au&gt;
6 years ago
/* Also caller supplied: is this invoked simply to get usage? */
bool command_usage_only(const struct command *cmd);
/* If so, this is called. */
void command_set_usage(struct command *cmd, const char *usage);
/* Also caller supplied: is this invoked simply to check parameters? */
bool command_check_only(const struct command *cmd);
#endif /* LIGHTNING_COMMON_JSON_COMMAND_H */