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...

#include <sapi_timer_backend.h>

Data Fields
sapi_status_t(*)	create (sapi_timer_storage_t storage, const sapi_timer_config_t config, sapi_timer_handle_t *out_handle)
	Backend implementation of sapi_timer_create(). May be NULL.
sapi_status_t(*)	start (sapi_timer_handle_t handle)
	Backend implementation of sapi_timer_start(). May be NULL.
sapi_status_t(*)	stop (sapi_timer_handle_t handle)
	Backend implementation of sapi_timer_stop(). May be NULL.
sapi_status_t(*)	destroy (sapi_timer_handle_t handle)
	Backend implementation of sapi_timer_destroy(). May be NULL.
sapi_status_t(*)	now (sapi_timestamp_ms_t *out_now_ms)
	Backend implementation of sapi_timer_now(). May be NULL.

Detailed Description

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.

Definition at line 34 of file sapi_timer_backend.h.

Field Documentation

◆ create

sapi_status_t(*) sapi_timer_backend_t::create(sapi_timer_storage_t *storage, const sapi_timer_config_t *config, sapi_timer_handle_t *out_handle)

Backend implementation of sapi_timer_create(). May be NULL.

Definition at line 37 of file sapi_timer_backend.h.

◆ start

sapi_status_t(*) sapi_timer_backend_t::start(sapi_timer_handle_t handle)

Backend implementation of sapi_timer_start(). May be NULL.

Definition at line 41 of file sapi_timer_backend.h.

◆ stop

sapi_status_t(*) sapi_timer_backend_t::stop(sapi_timer_handle_t handle)

Backend implementation of sapi_timer_stop(). May be NULL.

Definition at line 43 of file sapi_timer_backend.h.

◆ destroy

sapi_status_t(*) sapi_timer_backend_t::destroy(sapi_timer_handle_t handle)

Backend implementation of sapi_timer_destroy(). May be NULL.

Definition at line 45 of file sapi_timer_backend.h.

◆ now

sapi_status_t(*) sapi_timer_backend_t::now(sapi_timestamp_ms_t *out_now_ms)

Backend implementation of sapi_timer_now(). May be NULL.

Definition at line 47 of file sapi_timer_backend.h.

The documentation for this struct was generated from the following file:

include/safeapi_backend/timer/sapi_timer_backend.h