sapi_timer_backend.h File Reference

OS-backend adaptation surface for the Timer service (ADR-005, ADR-021). More...

#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/oal/timer/sapi_timer.h"

Include dependency graph for sapi_timer_backend.h:

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

Go to the source code of this file.

Data Structures
struct	sapi_timer_backend_t
	Backend vtable: an integrator's implementation of the timer service for a specific OS/RTOS/BSP target (ADR-005). Any slot may be NULL if that operation is unsupported by the backend, in which case the corresponding sapi_timer_* call returns SAPI_STATUS_NOT_SUPPORTED. More...

Functions
sapi_status_t	sapi_timer_register_backend (const sapi_timer_backend_t *backend)
	Registers the backend implementation used by every sapi_timer_* call. This is how an integrator supplies their own timer implementation (ADR-005 section 2.1) - call once at startup, before any other sapi_timer_* function.

Detailed Description

OS-backend adaptation surface for the Timer service (ADR-005, ADR-021).

This header is for platform/RTOS integrators implementing a sapi_timer_backend_t and calling sapi_timer_register_backend() - it is NOT part of the API a consuming application uses to create/start/stop timers (that is safeapi/timer/sapi_timer.h). A real application should never need to include this file; only the one piece of startup code that wires a concrete backend into the framework should.

Definition in file sapi_timer_backend.h.