Safe API Framework
Layered API framework for safety-related applications (ERTMS RBC reference targeting CENELEC EN 50128 SIL 4)
Toggle main menu visibility
Loading...
Searching...
No Matches
sapi_safety_violation.h
Go to the documentation of this file.
1
52
#ifndef SAFEAPI_COMMON_SAFETY_VIOLATION_H
53
#define SAFEAPI_COMMON_SAFETY_VIOLATION_H
54
55
#include "
safeapi/utils/status/sapi_status.h
"
56
#include "
safeapi/utils/types/sapi_types.h
"
57
58
#ifdef __cplusplus
59
extern
"C"
{
60
#endif
61
65
typedef
enum
sapi_safety_violation_kind_e
66
{
69
SAPI_SAFETY_VIOLATION_CORRUPTION
= 0,
72
SAPI_SAFETY_VIOLATION_OVERFLOW
= 1,
77
SAPI_SAFETY_VIOLATION_OUT_OF_RANGE
= 2
78
}
sapi_safety_violation_kind_t
;
79
99
typedef
void (*
sapi_safety_violation_handler_t
)(
sapi_safety_violation_kind_t
kind,
100
const
char
*file,
101
int32_t line,
102
const
char
*message);
103
117
sapi_status_t
sapi_safety_violation_register_handler
(
sapi_safety_violation_handler_t
handler);
118
135
void
sapi_safety_violation_report
(
sapi_safety_violation_kind_t
kind,
136
const
char
*file,
137
int32_t line,
138
const
char
*message);
139
140
#ifdef __cplusplus
141
}
142
#endif
143
144
#endif
/* SAFEAPI_COMMON_SAFETY_VIOLATION_H */
145
/* SAFETYVIOLATION */
sapi_safety_violation_report
void sapi_safety_violation_report(sapi_safety_violation_kind_t kind, const char *file, int32_t line, const char *message)
Reports one violation to the registered handler, if any.
Definition
sapi_safety_violation.c:20
sapi_safety_violation_register_handler
sapi_status_t sapi_safety_violation_register_handler(sapi_safety_violation_handler_t handler)
Registers the single handler invoked by sapi_safety_violation_report(). Registering again replaces th...
Definition
sapi_safety_violation.c:10
sapi_safety_violation_handler_t
void(*) sapi_safety_violation_handler_t(sapi_safety_violation_kind_t kind, const char *file, int32_t line, const char *message)
Handler invoked by sapi_safety_violation_report().
Definition
sapi_safety_violation.h:99
sapi_safety_violation_kind_t
sapi_safety_violation_kind_t
Which safety primitive detected the violation.
Definition
sapi_safety_violation.h:66
SAPI_SAFETY_VIOLATION_CORRUPTION
@ SAPI_SAFETY_VIOLATION_CORRUPTION
Definition
sapi_safety_violation.h:69
SAPI_SAFETY_VIOLATION_OUT_OF_RANGE
@ SAPI_SAFETY_VIOLATION_OUT_OF_RANGE
Definition
sapi_safety_violation.h:77
SAPI_SAFETY_VIOLATION_OVERFLOW
@ SAPI_SAFETY_VIOLATION_OVERFLOW
Definition
sapi_safety_violation.h:72
sapi_status_t
sapi_status_t
Common result/status codes.
Definition
sapi_status.h:27
sapi_status.h
Common status/error codes returned by every Safe API Framework function. Shared across all OS Abstrac...
sapi_types.h
Common fixed-width types and the caller-owned-storage handle pattern used by every OAL service (see A...
include
safeapi
utils
safestate
sapi_safety_violation.h
Generated by
1.18.0