sapi_timer.h

Go to the documentation of this file.

#ifndef SAFEAPI_OS_TIMER_H
#define SAFEAPI_OS_TIMER_H
 
#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/utils/types/sapi_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

SAFEAPI_DECLARE_STORAGE(sapi_timer_storage_t, 64U);

typedef struct sapi_timer_impl_s *sapi_timer_handle_t;

typedef enum sapi_timer_mode_e
{
    SAPI_TIMER_MODE_ONE_SHOT = 0, 
    SAPI_TIMER_MODE_PERIODIC = 1  
} sapi_timer_mode_t;

typedef void (*sapi_timer_callback_t)(sapi_timer_handle_t handle, void *user_ctx);

typedef struct sapi_timer_config_s
{
    sapi_timer_mode_t      mode;         
    sapi_duration_ms_t     period_ms;    
    sapi_timer_callback_t  callback;     
    void                  *user_ctx;     
} sapi_timer_config_t;

sapi_status_t sapi_timer_create(sapi_timer_storage_t *storage,
                                 const sapi_timer_config_t *config,
                                 sapi_timer_handle_t *out_handle);

sapi_status_t sapi_timer_start(sapi_timer_handle_t handle);

sapi_status_t sapi_timer_stop(sapi_timer_handle_t handle);

sapi_status_t sapi_timer_destroy(sapi_timer_handle_t handle);

sapi_status_t sapi_timer_now(sapi_timestamp_ms_t *out_now_ms);
 
/*
 * The backend vtable (sapi_timer_backend_t) and sapi_timer_register_backend()
 * live in safeapi_backend/timer/sapi_timer_backend.h, not here (ADR-021).
 * This header is the consumer-facing surface only - a real application
 * never needs to see the backend vtable shape; only the platform
 * integrator wiring a concrete backend does.
 */
 
#ifdef __cplusplus
}
#endif
 
#endif /* SAFEAPI_OS_TIMER_H */
 /* TIMER */