Lightweight Parallel Foundations 1.0.1-alpha 2023-06-26T11:02:34Z
A high performance and model-compliant communication layer
Variables
Error Codes
Collaboration diagram for Error Codes:

Variables

const lpf_err_t LPF_SUCCESS
 
const lpf_err_t LPF_ERR_OUT_OF_MEMORY
 
const lpf_err_t LPF_ERR_FATAL
 

Detailed Description

The set of distinct error codes that are used by functions in the Core API. Distinct error codes shall never compare equal (as also per lpf_err_t).

All LPF primitives return an error code of type lpf_err_t.

These are the minimal set of error codes. Implementations may choose to introduce additional error codes, though these must never compare equal to any of the error codes defined here. Additionally, a successful function call must always return LPF_SUCCESS.

Variable Documentation

◆ LPF_SUCCESS

const lpf_err_t LPF_SUCCESS
extern

Return code indicating the function call completed successfully.

◆ LPF_ERR_OUT_OF_MEMORY

const lpf_err_t LPF_ERR_OUT_OF_MEMORY
extern

Return code indicating the function call encountered an out-of-memory exception.

◆ LPF_ERR_FATAL

const lpf_err_t LPF_ERR_FATAL
extern

Return code indicating a fatal error, one that results in undefined behaviour and thus cannot be mitigated by the user.