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 #include <boost/multi_index_container.hpp>
32 #include <boost/multi_index/ordered_index.hpp>
33 #include <boost/multi_index/member.hpp>
35 #include <senf/Scheduler/ClockService.hh>
36 #include <senf/Scheduler/TimerEvent.hh>
38 ///////////////////////////////hh.p////////////////////////////////////////
42 /** \brief Deadline timer proxy
44 The TimerEventProxy is meant to host long term deadline timers to reduce the load of the
45 Scheduler with a huge count of TimerEvent items. It registers deadline timer callbacks which
46 will be called when the timer expires.
48 The functionality is based on one TimerEvent instance per TimerEventProxy instance and could
49 host a big count of timers.
51 template<typename IdType>
55 typedef boost::function<void(ClockService::clock_type, IdType const &)> Callback;
57 TimerEventProxy(std::string const & description = "");
58 ///< Instantiate a TimerEventProxy
59 /**< \param[in] description Descriptive name (purely informational) */
61 void add(ClockService::clock_type timeout, IdType const & id, Callback cb);
62 ///< Add new deadline timer
64 bool remove(IdType const & id); ///< Remove timer by given \a id.
66 std::vector<std::pair<ClockService::clock_type, IdType> > list() const;
67 ///< Returns a vector of all active timers with timeout and id.
69 ClockService::clock_type timeout(IdType const & id) const;
70 ///< Returns timeout for given id
71 /**< if no timer for this id is registered \a 0 is returned. */
75 ClockService::clock_type timeout;
79 Entry(ClockService::clock_type _timeout, IdType _id, Callback _cb)
80 : timeout(_timeout), id(_id), cb(_cb) { }
85 // data structure to hold active timers
86 typedef boost::multi_index_container<
88 boost::multi_index::indexed_by<
89 boost::multi_index::ordered_non_unique<
90 boost::multi_index::tag<Timeout>,
91 boost::multi_index::member<Entry, ClockService::clock_type, &Entry::timeout>
93 boost::multi_index::ordered_unique<
94 boost::multi_index::tag<Id>,
95 boost::multi_index::member<Entry, IdType, &Entry::id>
99 typedef typename EntrySet_t::template index<Timeout>::type EntrySetByTimeout_t;
100 typedef typename EntrySet_t::template index<Id>::type EntrySetById_t;
103 EntrySetById_t & entrySetById;
104 EntrySetByTimeout_t & entrySetByTimeout;
106 scheduler::TimerEvent timer;
108 void timerEvent(); // callback for the Scheduler timer event
113 ///////////////////////////////hh.e////////////////////////////////////////
114 //#include "TimerEventProxy.cci"
115 #include "TimerEventProxy.ct"
116 //#include "TimerEventProxy.cti"
123 // comment-column: 40
124 // c-file-style: "senf"
125 // indent-tabs-mode: nil
126 // ispell-local-dictionary: "american"
127 // compile-command: "scons -u test"