mirror of
https://github.com/aljazceru/lightning.git
synced 2025-12-19 07:04:22 +01:00
These routines free the 'struct command': a common coding error is not to return immediately. To catch this, we make them return a non-NULL 'struct command_result *', and we're going to make the command handlers return the same (to encourage 'return command_fail(...)'-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 <rusty@rustcorp.com.au>
27 lines
862 B
C
27 lines
862 B
C
/* 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;
|
|
struct command_result;
|
|
|
|
/* Caller supplied this: param assumes it can call it. */
|
|
struct command_result *command_fail(struct command *cmd, int code,
|
|
const char *fmt, ...)
|
|
PRINTF_FMT(3, 4);
|
|
|
|
/* 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 */
|