rte_timer.h

Go to the documentation of this file.

#ifndef RTE_OS_TIMER_H
#define RTE_OS_TIMER_H
 
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

RTE_DECLARE_STORAGE(rte_timer_storage_t, 64U);

typedef struct rte_timer_impl_s *rte_timer_handle_t;

typedef enum rte_timer_mode_e
{
    RTE_TIMER_MODE_ONE_SHOT = 0, 
    RTE_TIMER_MODE_PERIODIC = 1  
} rte_timer_mode_t;

typedef void (*rte_timer_callback_t)(rte_timer_handle_t handle, void *user_ctx);

typedef struct rte_timer_config_s
{
    rte_timer_mode_t      mode;         
    rte_duration_ms_t     period_ms;    
    rte_timer_callback_t  callback;     
    void                  *user_ctx;     
} rte_timer_config_t;

rte_status_t rte_timer_create(rte_timer_storage_t *storage,
                                 const rte_timer_config_t *config,
                                 rte_timer_handle_t *out_handle);

rte_status_t rte_timer_start(rte_timer_handle_t handle);

rte_status_t rte_timer_stop(rte_timer_handle_t handle);

rte_status_t rte_timer_destroy(rte_timer_handle_t handle);

rte_status_t rte_timer_now(rte_timestamp_ms_t *out_now_ms);
 
/*
 * The OSAdapter vtable (rte_osadapter_timer_t) and rte_osadapter_timer_register()
 * live in rte_osadapter/timer/rte_osadapter_timer.h, not here (ADR-021).
 * This header is the consumer-facing surface only - a real application
 * never needs to see the OSAdapter vtable shape; only the platform
 * integrator wiring a concrete OSAdapter does.
 */
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_OS_TIMER_H */
 /* TIMER */