meshx_rtos_timer.h

Go to the documentation of this file.

 
#ifndef __MESHX_RTOS_TIMER_H
#define __MESHX_RTOS_TIMER_H
 
#include <stdint.h>
#include <stdbool.h>
#include "meshx_err.h"
 
typedef void (*meshx_rtos_timer_callback_t)(void *);
 
typedef struct meshx_rtos_timer
{
    /* Public */
    void *timer_arg;
    bool auto_reload;
    uint32_t timer_period;
    const char *timer_name;
    meshx_rtos_timer_callback_t timer_cb;
    /* Private */
    void *__timer_handle;
}meshx_rtos_timer_t;

meshx_err_t meshx_rtos_timer_create(meshx_rtos_timer_t *timer, const char * name, meshx_rtos_timer_callback_t cb, void *arg, uint32_t period_ms, bool reload);
meshx_err_t meshx_rtos_timer_start(meshx_rtos_timer_t *timer);

meshx_err_t meshx_rtos_timer_stop(meshx_rtos_timer_t *timer);

meshx_err_t meshx_rtos_timer_delete(meshx_rtos_timer_t *timer);

meshx_err_t meshx_rtos_timer_change_period(meshx_rtos_timer_t *timer, uint32_t new_period_ms);

meshx_err_t meshx_rtos_timer_reset(meshx_rtos_timer_t *timer);
 
/*
 * @brief Callback function for the OS timer to control task.
 * @note This function is called internally not to be called by user.
 *
 * This function is called whenever a OS timer timeout occurs.
 *
 * @param timer_handle  Timer haandle callback param
 */
void meshx_os_timer_fire_cb(const void* timer_handle);
 
#endif /* __MESHX_RTOS_TIMER_H */