le_timer.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------

#ifndef LEGATO_TIMER_INCLUDE_GUARD
#define LEGATO_TIMER_INCLUDE_GUARD


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_timer* le_timer_Ref_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_timer_ExpiryHandler_t)
(
    le_timer_Ref_t timerRef
);


#if LE_CONFIG_TIMER_NAMES_ENABLED
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_timer_Ref_t le_timer_Create
(
    const char *nameStr
);
#else /* if not LE_CONFIG_TIMER_NAMES_ENABLED */
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_timer_Ref_t _le_timer_Create(void);
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_DECLARE_INLINE le_timer_Ref_t le_timer_Create
(
    const char *nameStr
)
{
    LE_UNUSED(nameStr);
    return _le_timer_Create();
}
#endif /* end LE_CONFIG_TIMER_NAMES_ENABLED */


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_timer_Delete
(
    le_timer_Ref_t timerRef                 
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_timer_SetHandler
(
    le_timer_Ref_t timerRef,                
    le_timer_ExpiryHandler_t handlerFunc    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_timer_SetInterval
(
    le_timer_Ref_t timerRef,     
    le_clk_Time_t interval       
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_clk_Time_t le_timer_GetInterval
(
    le_timer_Ref_t timerRef      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_timer_SetMsInterval
(
    le_timer_Ref_t timerRef,     
    uint32_t interval            
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t le_timer_GetMsInterval
(
    le_timer_Ref_t timerRef      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_timer_SetRepeat
(
    le_timer_Ref_t timerRef,     
    uint32_t repeatCount         
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_timer_SetWakeup
(
    le_timer_Ref_t timerRef,     
    bool wakeupEnabled           
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_timer_SetContextPtr
(
    le_timer_Ref_t timerRef,     
    void* contextPtr             
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void* le_timer_GetContextPtr
(
    le_timer_Ref_t timerRef      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t le_timer_GetExpiryCount
(
    le_timer_Ref_t timerRef      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_clk_Time_t le_timer_GetTimeRemaining
(
    le_timer_Ref_t timerRef      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
uint32_t le_timer_GetMsTimeRemaining
(
    le_timer_Ref_t timerRef      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_timer_Start
(
    le_timer_Ref_t timerRef      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_timer_Stop
(
    le_timer_Ref_t timerRef      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_timer_Restart
(
    le_timer_Ref_t timerRef      
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_timer_IsRunning
(
    le_timer_Ref_t timerRef      
);


#endif // LEGATO_TIMER_INCLUDE_GUARD