tickhook.hpp

/****************************************************************************
 *
 *  Copyright (c) 2017, Michael Becker (michael.f.becker@gmail.com)
 *
 *  This file is part of the FreeRTOS Add-ons project.
 *
 *  Source Code:
 *  https://github.com/michaelbecker/freertos-addons
 *
 *  Project Page:
 *  http://michaelbecker.github.io/freertos-addons/
 *
 *  On-line Documentation:
 *  http://michaelbecker.github.io/freertos-addons/docs/html/index.html
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a
 *  copy of this software and associated documentation files
 *  (the "Software"), to deal in the Software without restriction, including
 *  without limitation the rights to use, copy, modify, merge, publish,
 *  distribute, sublicense, and/or sell copies of the Software, and to
 *  permit persons to whom the Software is furnished to do so,subject to the
 *  following conditions:
 *
 *  + The above copyright notice and this permission notice shall be included
 *    in all copies or substantial portions of the Software.
 *  + Credit is appreciated, but not required, if you find this project
 *    useful enough to include in your application, product, device, etc.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 *  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 *  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 *  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 *  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 *  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 ***************************************************************************/
 
 
#include "freertos-config.h"
 
#ifndef TICK_HOOK_HPP_
#define TICK_HOOK_HPP_
 
#include "FreeRTOS.h"
#include "task.h"
#include <list>
 
#if ( configUSE_TICK_HOOK == 1 )
 
extern "C" void vApplicationTickHook(void);
 
namespace cpp_freertos {
 
class TickHook {
 
    //
    //  Public API
    //  Available from anywhere. 
    //
    public:
        TickHook();
 
        virtual ~TickHook();
 
        void Register();
        
        void Disable();
 
        void Enable();
        
 
    //
    //  Protected API
    //
    protected:
        virtual void Run() = 0;
 
 
    //
    //  Private API
    //  The internals of this wrapper class.
    //
    private:
        static std::list<TickHook *>Callbacks;
 
        bool Enabled;
 
    friend void ::vApplicationTickHook();
};
 
 
 
}
#endif
#endif