TimerEvent.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_Scheduler_TimerEvent_
#define HH_SENF_Scheduler_TimerEvent_ 1

// Custom includes
#include <signal.h>
#include <boost/intrusive/set_hook.hpp>
#include "ClockService.hh"
#include "FIFORunner.hh"
#include <senf/Utils/Logger/SenfLog.hh>
#include <senf/Scheduler/ClockService.hh>

//#include "TimerEvent.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace scheduler {

    namespace detail {
        struct TimerSetTag;
        typedef boost::intrusive::set_base_hook< boost::intrusive::tag<TimerSetTag> > TimerSetBase;
        struct TimerSetCompare;
        class TimerDispatcher;
    }

    class TimerEvent
        : public detail::FIFORunner::TaskInfo,
          public detail::TimerSetBase
    {
    public:
        //-////////////////////////////////////////////////////////////////////////
        // Types

        typedef boost::function<void ()> Callback;

        //-////////////////////////////////////////////////////////////////////////
        //\{

        TimerEvent(std::string const & name, Callback const & cb, ClockService::clock_type timeout,
                   bool initiallyEnabled = true);

        TimerEvent(std::string const & name, Callback const & cb);

        ~TimerEvent();

        //\}
        //-////////////////////////////////////////////////////////////////////////

        void disable();                 
        void enable();                  

        void action(Callback const & cb); 
        void timeout(ClockService::clock_type const & timeout, bool initiallyEnabled=true);

        ClockService::clock_type const & timeout() const;

    private:
        virtual void v_run();
        virtual char const * v_type() const;
        virtual std::string v_info() const;

        Callback cb_;
        ClockService::clock_type timeout_;

        friend class detail::TimerDispatcher;
        friend struct detail::TimerSetCompare;
    };

}}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "TimerEvent.cci"
//#include "TimerEvent.ct"
//#include "TimerEvent.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// comment-column: 40
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// End: