Scheduler/TimerEvent.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief TimerDispatcher public header */
  25
  26 #ifndef HH_TimerDispatcher_
  27 #define HH_TimerDispatcher_ 1
  28
  29 // Custom includes
  30 #include <signal.h>
  31 #include "../boost/intrusive/iset_hook.hpp"
  32 #include "ClockService.hh"
  33 #include "FdManager.hh"
  34 #include "FIFORunner.hh"
  35 #include "../Utils/Logger/SenfLog.hh"
  36
  37 //#include "TimerEvent.mpp"
  38 ///////////////////////////////hh.p////////////////////////////////////////
  39
  40 namespace senf {
  41 namespace scheduler {
  42
  43     namespace detail {
  44         struct TimerSetTag;
  45         typedef boost::intrusive::iset_base_hook<TimerSetTag> TimerSetBase;
  46         struct TimerSetCompare;
  47         class TimerDispatcher;
  48     }
  49
  50     class TimerEvent
  51         : public FIFORunner::TaskInfo,
  52           public detail::TimerSetBase
  53     {
  54     public:
  55         ///////////////////////////////////////////////////////////////////////////
  56         // Types
  57
  58         typedef boost::function<void ()> Callback;
  59
  60         ///////////////////////////////////////////////////////////////////////////
  61         ///\name Structors and default members
  62         ///@{
  63
  64         TimerEvent(std::string const & name, Callback const & cb, ClockService::clock_type timeout,
  65                    bool initiallyEnabled = true);
  66         TimerEvent(std::string const & name, Callback const & cb);
  67         ~TimerEvent();
  68
  69         ///@}
  70         ///////////////////////////////////////////////////////////////////////////
  71
  72         void enable();
  73         void disable();
  74         bool enabled();
  75
  76         void action(Callback const & cb);
  77         void timeout(ClockService::clock_type timeout, bool enable=true);
  78
  79     private:
  80         virtual void run();
  81
  82         Callback cb_;
  83         ClockService::clock_type timeout_;
  84
  85         friend class detail::TimerDispatcher;
  86         friend class detail::TimerSetCompare;
  87     };
  88
  89 }}
  90
  91 ///////////////////////////////hh.e////////////////////////////////////////
  92 #include "TimerEvent.cci"
  93 //#include "TimerEvent.ct"
  94 //#include "TimerEvent.cti"
  95 #endif
  96
  97 \f
  98 // Local Variables:
  99 // mode: c++
 100 // fill-column: 100
 101 // comment-column: 40
 102 // c-file-style: "senf"
 103 // indent-tabs-mode: nil
 104 // ispell-local-dictionary: "american"
 105 // compile-command: "scons -u test"
 106 // End: