mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 18:11:28 +01:00
55173a56b7
Before this patch we used `int` for error codes. The problem with `int` is that we try to pass it to/from wire and the size of `int` is not defined by the standard. So a sender with 4-byte `int` would write 4 bytes to the wire and a receiver with 2-byte `int` (for example) would read just 2 bytes from the wire. To resolve this: * Introduce an error code type with a known size: `typedef s32 errcode_t`. * Change all error code macros to constants of type `errcode_t`. Constants also play better with gdb - it would visualize the name of the constant instead of the numeric value. * Change all functions that take error codes to take the new type `errcode_t` instead of `int`. * Introduce towire / fromwire functions to send / receive the newly added type `errcode_t` and use it instead of `towire_int()`. In addition: * Remove the now unneeded `towire_int()`. * Replace a hardcoded error code `-2` with a new constant `INVOICE_EXPIRED_DURING_WAIT` (903). Changelog-Changed: The waitinvoice command would now return error code 903 to designate that the invoice expired during wait, instead of the previous -2
28 lines
915 B
C
28 lines
915 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 <common/errcode.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, errcode_t code,
|
|
const char *fmt, ...)
|
|
PRINTF_FMT(3, 4) WARN_UNUSED_RESULT;
|
|
|
|
/* 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 */
|