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_clocksync_backend.h
Go to the documentation of this file.
1
17
#ifndef SAPI_CLOCKSYNC_BACKEND_H
18
#define SAPI_CLOCKSYNC_BACKEND_H
19
20
#include <stdint.h>
21
22
#include "
safeapi/oal/clocksync/sapi_clocksync.h
"
23
#include "
safeapi/utils/status/sapi_status.h
"
24
25
#ifdef __cplusplus
26
extern
"C"
{
27
#endif
28
35
typedef
struct
sapi_clocksync_backend_s
36
{
40
sapi_status_t
(*
get_offset_ms
)(int64_t *out_offset_ms);
42
sapi_status_t
(*
get_quality
)(
sapi_clocksync_quality_t
*out_quality);
43
}
sapi_clocksync_backend_t
;
44
53
sapi_status_t
sapi_clocksync_register_backend
(
const
sapi_clocksync_backend_t
*backend);
54
55
#ifdef __cplusplus
56
}
57
#endif
58
59
#endif
/* SAPI_CLOCKSYNC_BACKEND_H */
60
/* CLOCKSYNC_BACKEND */
sapi_clocksync_register_backend
sapi_status_t sapi_clocksync_register_backend(const sapi_clocksync_backend_t *backend)
Registers the backend implementation used by every sapi_clocksync_* call (ADR-005-style single global...
Definition
sapi_clocksync.c:26
sapi_clocksync_quality_t
sapi_clocksync_quality_t
Coarse quality/confidence of the current clock synchronization.
Definition
sapi_clocksync.h:60
sapi_status_t
sapi_status_t
Common result/status codes.
Definition
sapi_status.h:27
sapi_clocksync.h
Pluggable wall-clock synchronization backend (ADR-017).
sapi_status.h
Common status/error codes returned by every Safe API Framework function. Shared across all OS Abstrac...
sapi_clocksync_backend_t
Backend vtable: an integrator's implementation of clock synchronization for a specific mechanism (PTP...
Definition
sapi_clocksync_backend.h:36
sapi_clocksync_backend_t::get_offset_ms
sapi_status_t(*) get_offset_ms(int64_t *out_offset_ms)
Definition
sapi_clocksync_backend.h:40
sapi_clocksync_backend_t::get_quality
sapi_status_t(*) get_quality(sapi_clocksync_quality_t *out_quality)
Definition
sapi_clocksync_backend.h:42
include
safeapi_backend
clocksync
sapi_clocksync_backend.h
Generated by
1.18.0