check.h File Reference

#include <tinyformat.h>
#include <stdexcept>

Include dependency graph for check.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	NonFatalCheckError

Macros
#define	CHECK_NONFATAL(condition)
	Throw a NonFatalCheckError when the condition evaluates to false. More...

Macro Definition Documentation

CHECK_NONFATAL

#define CHECK_NONFATAL

(

condition

)

Value:

do {                                                          \
        if (!(condition)) {                                       \
            throw NonFatalCheckError(                             \
                strprintf("%s:%d (%s)\n"                          \
                          "Internal bug detected: '%s'\n"         \
                          "You may report this issue here: %s\n", \
                    __FILE__, __LINE__, __func__,                 \
                    (#condition),                                 \
                    PACKAGE_BUGREPORT));                          \
        }                                                         \
    } while (false)

Throw a NonFatalCheckError when the condition evaluates to false.

This should only be used

• where the condition is assumed to be true, not for error handling or validating user input
• where a failure to fulfill the condition is recoverable and does not abort the program

For example in RPC code, where it is undersirable to crash the whole program, this can be generally used to replace asserts or recoverable logic errors. A NonFatalCheckError in RPC code is caught and passed as a string to the RPC caller, which can then report the issue to the developers.

Definition at line 28 of file check.h.