senf/Scheduler/TimerEventProxy.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2010
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Mathias Kretschmer <mtk@berlios.de>
   7 //     Jens Moedeker <jens.moedeker@fokus.fraunhofer.de>
   8 //
   9 // This program is free software; you can redistribute it and/or modify
  10 // it under the terms of the GNU General Public License as published by
  11 // the Free Software Foundation; either version 2 of the License, or
  12 // (at your option) any later version.
  13 //
  14 // This program is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 // GNU General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU General Public License
  20 // along with this program; if not, write to the
  21 // Free Software Foundation, Inc.,
  22 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23
  24 /** \file
  25     \brief TimerEventProxy public header */
  26
  27 #ifndef HH_SENF_Scheduler_TimerEventProxy_
  28 #define HH_SENF_Scheduler_TimerEventProxy_ 1
  29
  30 // Custom includes
  31 #include <boost/multi_index_container.hpp>
  32 #include <boost/multi_index/ordered_index.hpp>
  33 #include <boost/multi_index/member.hpp>
  34
  35 #include <senf/Scheduler/ClockService.hh>
  36 #include <senf/Scheduler/TimerEvent.hh>
  37 #include <senf/Utils/Console/Console.hh>
  38
  39 ///////////////////////////////hh.p////////////////////////////////////////
  40 namespace senf {
  41 namespace scheduler {
  42
  43     /** \brief Deadline timer proxy
  44
  45         The TimerEventProxy is meant to host long term deadline timers to reduce the load of the
  46         Scheduler with a huge count of TimerEvent items. It registers deadline timer callbacks which
  47         will be called when the timer expires.
  48
  49         The functionality is based on one TimerEvent instance per TimerEventProxy instance and could
  50         host a big count of timers.
  51      */
  52     template<typename IdType>
  53     class TimerEventProxy
  54     {
  55     public:
  56         typedef boost::function<void(ClockService::clock_type, IdType const &)> Callback;
  57
  58         TimerEventProxy(std::string const & description = "");
  59                                         ///< Instantiate a TimerEventProxy
  60                                         /**< \param[in] description Descriptive name (purely informational) */
  61
  62         void add(ClockService::clock_type timeout, IdType const & id, Callback cb);
  63                                         ///< Add new deadline timer
  64
  65         bool remove(IdType const & id); ///< Remove timer by given \a id.
  66
  67         std::vector<std::pair<ClockService::clock_type, IdType> > list() const;
  68                                         ///< Returns a vector of all active timers with timeout and id.
  69
  70         ClockService::clock_type timeout(IdType const & id) const;
  71                                         ///< Returns timeout for given id
  72                                         /**< if no timer for this id is registered \a 0 is returned. */
  73     private:
  74 #ifndef DOXYGEN
  75         struct Entry {
  76             ClockService::clock_type timeout;
  77             IdType id;
  78             Callback cb;
  79
  80             Entry(ClockService::clock_type _timeout, IdType _id, Callback _cb)
  81                 : timeout(_timeout), id(_id), cb(_cb) { }
  82         };
  83         struct Timeout {};
  84         struct Id {};
  85 #endif
  86         // data structure to hold active timers
  87         typedef boost::multi_index_container<
  88             Entry,
  89             boost::multi_index::indexed_by<
  90                 boost::multi_index::ordered_non_unique<
  91                     boost::multi_index::tag<Timeout>,
  92                     boost::multi_index::member<Entry, ClockService::clock_type, &Entry::timeout>
  93                 >,
  94                 boost::multi_index::ordered_unique<
  95                     boost::multi_index::tag<Id>,
  96                     boost::multi_index::member<Entry, IdType, &Entry::id>
  97                 >
  98             >
  99         > EntrySet_t;
 100         typedef typename EntrySet_t::template index<Timeout>::type EntrySetByTimeout_t;
 101         typedef typename EntrySet_t::template index<Id>::type EntrySetById_t;
 102
 103         EntrySet_t entrySet;
 104         EntrySetById_t & entrySetById;
 105         EntrySetByTimeout_t & entrySetByTimeout;
 106
 107         scheduler::TimerEvent timer;
 108
 109         void timerEvent();  // callback for the Scheduler timer event
 110     };
 111
 112 }}
 113
 114 ///////////////////////////////hh.e////////////////////////////////////////
 115 //#include "TimerEventProxy.cci"
 116 #include "TimerEventProxy.ct"
 117 //#include "TimerEventProxy.cti"
 118 #endif
 119
 120 \f
 121 // Local Variables:
 122 // mode: c++
 123 // fill-column: 100
 124 // comment-column: 40
 125 // c-file-style: "senf"
 126 // indent-tabs-mode: nil
 127 // ispell-local-dictionary: "american"
 128 // compile-command: "scons -u test"
 129 // End: