mn_timer.hpp

Go to the documentation of this file.

 
#ifndef MINLIB_FREERTOS_TIMER_
#define MINLIB_FREERTOS_TIMER_
 
#include "mn_config.hpp"
#include "mn_itimer.hpp"
 
namespace mn {
    class basic_timer {
    public:
        basic_timer(const char * strName,
            unsigned int uiPeriod, bool bIsOneShot = true);
 
        virtual ~basic_timer() { destroy(); }
        virtual int create();
 
        virtual int destroy(unsigned int timeout = (unsigned int) 0xffffffffUL);
 
        virtual int active(unsigned int timeout = (unsigned int) 0xffffffffUL);
 
        virtual int inactive(unsigned int timeout = (unsigned int) 0xffffffffUL);
 
        virtual int reset(unsigned int timeout = (unsigned int) 0xffffffffUL);
 
        virtual bool set_period(unsigned int uiNewPeriod, unsigned int timeout = (unsigned int) 0xffffffffUL);
 
        virtual unsigned int get_period()   { return m_uiPeriod; }
 
        const char* get_name()      { return m_strName; }
 
        bool        is_oneshot()    { return m_bIsOneShot; }
 
        virtual void*       get_handle()    { return m_pHandle; }
 
        int         get_id()        { return m_iTimerID; }
 
        virtual void        set_id(int nId);
 
        virtual bool        is_running();
 
        operator bool() { return is_running(); }
    protected:
        virtual void on_timer() = 0;
 
        virtual void on_enter() { }
        virtual void on_exit() { }
    protected:
        static void runtimerstub(void* xTimer);
    private:
        bool m_bIsOneShot;
        unsigned int m_uiPeriod;
        const char* m_strName;
        void* m_pHandle;
 
        int m_iTimerID;
 
        #if( configSUPPORT_STATIC_ALLOCATION == 1 )
            StaticTimer_t m_xTimerBuffer;
        #endif
    };
 
    using timer_t = basic_timer;
}
 
#endif