libe3 Error Codes

Error codes returned by libe3 operations. More...

Macros
#define	LIBE3_ERROR_CODE_LIST
	X-macro list of all libe3 error codes.

Detailed Description

Error codes returned by libe3 operations.

All libe3 API functions that can fail return either libe3::ErrorCode (C++ API) or e3_error_t (C API). A return value of 0 always means success; all error values are negative.

Macro Definition Documentation

LIBE3_ERROR_CODE_LIST

#define LIBE3_ERROR_CODE_LIST

Value:

    X(SUCCESS, 0) \
    X(INVALID_PARAM, -1) \
    X(NOT_INITIALIZED, -2) \
    X(ALREADY_INITIALIZED, -3) \
    X(NOT_CONNECTED, -4) \
    X(CONNECTION_FAILED, -5) \
    X(TIMEOUT, -6) \
    X(ENCODE_FAILED, -7) \
    X(DECODE_FAILED, -8) \
    X(SM_NOT_FOUND, -9) \
    X(SM_ALREADY_REGISTERED, -10) \
    X(BUFFER_TOO_SMALL, -11) \
    X(INTERNAL_ERROR, -12) \
    X(SUBSCRIPTION_EXISTS, -13) \
    X(SUBSCRIPTION_NOT_FOUND, -14) \
    X(DAPP_NOT_REGISTERED, -15) \
    X(TRANSPORT_ERROR, -16) \
    X(STATE_ERROR, -17) \
    X(SM_START_FAILED, -18) \
    X(NOT_FOUND, -19) \
    X(SM_ERROR_INVALID_PARAM, -20) \
    X(SM_ERROR_NOT_FOUND, -21) \
    X(SM_ERROR_ALREADY_EXISTS, -22) \
    X(SM_ERROR_THREAD_FAILED, -23) \
    X(SM_ERROR_MEMORY, -24) \
    X(CANCELLED, -25) \
    X(GENERIC_ERROR, -100)

X-macro list of all libe3 error codes.

Expand with #define X(name, val) ... before using this macro, and #undef X afterwards. Each entry exposes a symbolic name and its corresponding integer value.

Name	Value	Meaning
SUCCESS	0	Operation completed successfully
INVALID_PARAM	-1	One or more parameters are invalid
NOT_INITIALIZED	-2	Component has not been initialized yet
ALREADY_INITIALIZED	-3	Component is already initialized
NOT_CONNECTED	-4	No active connection available
CONNECTION_FAILED	-5	Failed to establish a connection
TIMEOUT	-6	Operation timed out
ENCODE_FAILED	-7	PDU encoding failed
DECODE_FAILED	-8	PDU decoding failed
SM_NOT_FOUND	-9	Requested Service Model was not found
SM_ALREADY_REGISTERED	-10	Service Model is already registered
BUFFER_TOO_SMALL	-11	Provided buffer is too small
INTERNAL_ERROR	-12	Unexpected internal error
SUBSCRIPTION_EXISTS	-13	Subscription already exists
SUBSCRIPTION_NOT_FOUND	-14	Subscription was not found
DAPP_NOT_REGISTERED	-15	Requested dApp is not registered
TRANSPORT_ERROR	-16	Transport layer error
STATE_ERROR	-17	Operation not valid in current state
SM_START_FAILED	-18	Service Model failed to start
NOT_FOUND	-19	Requested resource was not found
SM_ERROR_INVALID_PARAM	-20	Service Model received invalid parameter
SM_ERROR_NOT_FOUND	-21	Service Model resource not found
SM_ERROR_ALREADY_EXISTS	-22	Service Model resource already exists
SM_ERROR_THREAD_FAILED	-23	Service Model thread failed to start
SM_ERROR_MEMORY	-24	Service Model memory allocation failure
CANCELLED	-25	Operation was cancelled
GENERIC_ERROR	-100	Unclassified generic error

Definition at line 67 of file error_codes.h.