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>
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.
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.
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.
25 \brief TimerEventProxy public header */
27 #ifndef HH_SENF_Scheduler_TimerEventProxy_
28 #define HH_SENF_Scheduler_TimerEventProxy_ 1
31 # define BOOST_MULTI_INDEX_ENABLE_INVARIANT_CHECKING
32 # define BOOST_MULTI_INDEX_ENABLE_SAFE_MODE
35 #include <boost/range/iterator_range.hpp>
36 #include <boost/multi_index_container.hpp>
37 #include <boost/multi_index/ordered_index.hpp>
38 #include <boost/multi_index/member.hpp>
40 #include <senf/Scheduler/ClockService.hh>
41 #include <senf/Scheduler/TimerEvent.hh>
42 #include <senf/Utils/Console/Console.hh>
47 /** \brief Deadline timer proxy
49 The TimerEventProxy is meant to host long term deadline timers to reduce the load of the
50 Scheduler with a huge count of TimerEvent items. It registers deadline timer callbacks which
51 will be called when the timer expires.
53 The functionality is based on one TimerEvent instance per TimerEventProxy instance and could
54 host a big count of timers.
56 template<typename IdType>
60 ///////////////////////////////////////////////////////////////////////////
62 typedef boost::function<void(senf::ClockService::clock_type, IdType const &)> Callback;
65 ///< Instantiate a TimerEventProxy
67 TimerEventProxy(std::string const & name, senf::console::DirectoryNode & node);
68 ///< Instantiate a TimerEventProxy and add the list command to the give DirectoryNode
70 void add(senf::ClockService::clock_type timeout, IdType const &id, Callback cb);
71 ///< Add new deadline timer
72 bool remove(IdType const & id);
73 ///< Remove timer by given \a id.
74 std::vector<std::pair<senf::ClockService::clock_type, IdType> > list();
75 ///< Returns a vector of all active timers with timeout and id.
80 senf::ClockService::clock_type timeout;
84 Entry(senf::ClockService::clock_type _timeout, IdType _id, Callback _cb)
85 : timeout(_timeout), id(_id), cb(_cb) { }
88 senf::scheduler::TimerEvent timer;
91 // data structure to hold active timers
96 typedef boost::multi_index_container<
98 boost::multi_index::indexed_by<
99 boost::multi_index::ordered_non_unique<
100 boost::multi_index::tag<Timeout>,
101 boost::multi_index::member<Entry, senf::ClockService::clock_type, &Entry::timeout>
103 boost::multi_index::ordered_unique<
104 boost::multi_index::tag<Id>,
105 boost::multi_index::member<Entry, IdType, &Entry::id>
110 typedef typename EntrySet_t::template index<Timeout>::type EntrySetByTimeout_t;
111 typedef typename EntrySet_t::template index<Id>::type EntrySetById_t;
114 EntrySetById_t & entrySetById;
115 EntrySetByTimeout_t & entrySetByTimeout;
117 // callback for the Scheduler timer event
123 #include "TimerEventProxy.ct"