Safe API Framework
Layered API framework for safety-related applications (ERTMS RBC reference targeting CENELEC EN 50128 SIL 4)
Loading...
Searching...
No Matches
sapi_status.h File Reference

Common status/error codes returned by every Safe API Framework function. Shared across all OS Abstraction Layer (OAL) services. More...

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

Go to the source code of this file.

Enumerations

enum  sapi_status_t {
  SAPI_STATUS_OK = 0 , SAPI_STATUS_INVALID_PARAM = 1 , SAPI_STATUS_NOT_INITIALIZED = 2 , SAPI_STATUS_ALREADY_INITIALIZED = 3 ,
  SAPI_STATUS_TIMEOUT = 4 , SAPI_STATUS_RESOURCE_EXHAUSTED = 5 , SAPI_STATUS_NOT_SUPPORTED = 6 , SAPI_STATUS_NOT_IMPLEMENTED = 7 ,
  SAPI_STATUS_HARDWARE_FAULT = 8 , SAPI_STATUS_DATA_CORRUPTION = 9 , SAPI_STATUS_INTERNAL_ERROR = 10 , SAPI_STATUS_VALUE_OUT_OF_RANGE = 11 ,
  SAPI_STATUS_INVALID_STATE = 12
}
 Common result/status codes. More...

Functions

const char * sapi_status_to_string (sapi_status_t status)
 Returns a short, static, human-readable string for a status code. Intended for diagnostics/logging only; never on a safety-decision path.

Detailed Description

Common status/error codes returned by every Safe API Framework function. Shared across all OS Abstraction Layer (OAL) services.

REQ-OAL-COMMON-001: every fallible API function shall return sapi_status_t and shall not use exceptions or errno-style side channels.

Definition in file sapi_status.h.