//
// Copyright (C) 2010
// Fraunhofer Institute for Open Communication Systems (FOKUS)
-// Competence Center NETwork research (NET), St. Augustin, GERMANY
-// Mathias Kretschmer <mtk@berlios.de>
//
-// This program is free software; you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation; either version 2 of the License, or
-// (at your option) any later version.
+// The contents of this file are subject to the Fraunhofer FOKUS Public License
+// Version 1.0 (the "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at
+// http://senf.berlios.de/license.html
//
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-// GNU General Public License for more details.
+// The Fraunhofer FOKUS Public License Version 1.0 is based on,
+// but modifies the Mozilla Public License Version 1.1.
+// See the full license text for the amendments.
//
-// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the
-// Free Software Foundation, Inc.,
-// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+// Software distributed under the License is distributed on an "AS IS" basis,
+// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+// for the specific language governing rights and limitations under the License.
+//
+// The Original Code is Fraunhofer FOKUS code.
+//
+// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
+// (registered association), Hansastraße 27 c, 80686 Munich, Germany.
+// All Rights Reserved.
+//
+// Contributor(s):
+// Mathias Kretschmer <mtk@berlios.de>
+// Jens Moedeker <jmo@berlios.de>
/** \file
- \brief TimerEventProxy public header */
+ \brief TimerEventProxy public header */
#ifndef HH_SENF_Scheduler_TimerEventProxy_
#define HH_SENF_Scheduler_TimerEventProxy_ 1
-#ifdef SENF_DEBUG
-# define BOOST_MULTI_INDEX_ENABLE_INVARIANT_CHECKING
-# define BOOST_MULTI_INDEX_ENABLE_SAFE_MODE
-#endif
-
-#include <boost/range/iterator_range.hpp>
+// Custom includes
#include <boost/multi_index_container.hpp>
#include <boost/multi_index/ordered_index.hpp>
-#include <boost/multi_index/hashed_index.hpp>
-#include <boost/multi_index/sequenced_index.hpp>
-#include <boost/multi_index/key_extractors.hpp>
-#include <boost/multi_index/random_access_index.hpp>
-#include <boost/multi_index/identity.hpp>
#include <boost/multi_index/member.hpp>
#include <senf/Scheduler/ClockService.hh>
#include <senf/Scheduler/TimerEvent.hh>
-#include <senf/Utils/Console/Console.hh>
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
namespace senf {
namespace scheduler {
-
/** \brief Deadline timer proxy
- The TimerEventProxy is meant to host long term deadline timers to reduce the load of the
- Scheduler with a hugh count of TimerEvent items. It registers deadline timer callbacks which
+ The TimerEventProxy is meant to host long %term deadline timers to reduce the load of the
+ Scheduler with a huge count of TimerEvent items. It registers deadline timer callbacks which
will be called when the timer expires.
The functionality is based on one TimerEvent instance per TimerEventProxy instance and could
host a big count of timers.
*/
- template<class T>
- class TimerEventProxy {
- private:
+ template<typename IdType>
+ class TimerEventProxy
+ {
+ public:
+ typedef boost::function<void(ClockService::clock_type, IdType const &)> Callback;
- template<class T_>
- struct Entry {
- public:
- senf::ClockService::clock_type timeout;
- T id;
- boost::function<void(senf::ClockService::clock_type, T_ const &)> fkt;
-
- bool operator<(const Entry<T_> & e) const {
- return id < e.id;
- }
- // bool operator==(const Entry<T> &e)const{return id == e.id;}
- Entry(senf::ClockService::clock_type _timeout, T_ _id, boost::function<void(
- senf::ClockService::clock_type, T_)> _fkt) :
- timeout(_timeout), id(_id), fkt(_fkt) {
- }
- };
+ TimerEventProxy(std::string const & description = "");
+ ///< Instantiate a TimerEventProxy
+ /**< \param[in] description Descriptive name (purely informational) */
+ void add(ClockService::clock_type timeout, IdType const & id, Callback cb);
+ ///< Add new deadline timer
- senf::scheduler::TimerEvent timer;
+ bool remove(IdType const & id); ///< Remove timer by given \a id.
- //
- // data structure to hold active timers
- //
+ std::vector<std::pair<ClockService::clock_type, IdType> > list() const;
+ ///< Returns a vector of all active timers with timeout and id.
+
+ ClockService::clock_type timeout(IdType const & id) const;
+ ///< Returns timeout for given id
+ /**< if no timer for this id is registered \a 0 is returned. */
+
+ unsigned numEvents() const; ///< Returns the number of pending timer events
+
+ void clear(); ///< Clears all pending timer events
+
+ private:
+#ifndef DOXYGEN
+ struct Entry {
+ ClockService::clock_type timeout;
+ IdType id;
+ Callback cb;
+
+ Entry(ClockService::clock_type _timeout, IdType _id, Callback _cb)
+ : timeout(_timeout), id(_id), cb(_cb) { }
+ };
struct Timeout {};
struct Id {};
- typedef boost::multi_index_container<Entry<T> ,
- boost::multi_index::indexed_by<
- boost::multi_index::ordered_non_unique<
- boost::multi_index::tag<Timeout>,
- boost::multi_index::member<Entry<T> ,
- senf::ClockService::clock_type,
- &Entry<T>::timeout> >,
- boost::multi_index::ordered_unique<boost::multi_index::tag<
- Id>, boost::multi_index::identity<Entry<T> > > > >
- EntrySet;
-
- typedef typename EntrySet::template index<Timeout>::type
- EntrySetByTimeout_t;
- typedef typename EntrySet::template index<Id>::type EntrySetById_t;
-
- EntrySet entrySet;
+#endif
+ // data structure to hold active timers
+ typedef boost::multi_index_container<
+ Entry,
+ boost::multi_index::indexed_by<
+ boost::multi_index::ordered_non_unique<
+ boost::multi_index::tag<Timeout>,
+ boost::multi_index::member<Entry, ClockService::clock_type, &Entry::timeout>
+ >,
+ boost::multi_index::ordered_unique<
+ boost::multi_index::tag<Id>,
+ boost::multi_index::member<Entry, IdType, &Entry::id>
+ >
+ >
+ > EntrySet_t;
+ typedef typename EntrySet_t::template index<Timeout>::type EntrySetByTimeout_t;
+ typedef typename EntrySet_t::template index<Id>::type EntrySetById_t;
+
+ EntrySet_t entrySet;
EntrySetById_t & entrySetById;
EntrySetByTimeout_t & entrySetByTimeout;
- private:
- // callback for the Scheduler timer event
- void timerEvent();
+ scheduler::TimerEvent timer;
- public:
- ///////////////////////////////////////////////////////////////////////////
- // Types
- typedef boost::function<void(senf::ClockService::clock_type, T const &)> Callback;
-
- TimerEventProxy();
- ///< Instantiate a TimerEventProxy
-
- TimerEventProxy(std::string const & name, senf::console::DirectoryNode & node);
- ///< Instantiate a TimerEventProxy and add the list command to the give DirectoryNode
-
- void add(senf::ClockService::clock_type timeout, T const &id, Callback cb);
- ///< Add new deadline timer
- bool del(T const & id);
- ///< Remove timer by given \a id.
- std::vector<std::pair<senf::ClockService::clock_type, T> > list();
- ///< Returns a vector of all active timers with timeout and id.
+ void timerEvent(); // callback for the Scheduler timer event
};
-}
-}
-#include "TimerEventProxy.ct"
+}}
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
+//#include "TimerEventProxy.cci"
+#include "TimerEventProxy.ct"
+//#include "TimerEventProxy.cti"
#endif
+
+\f
+// 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:
projects / senf.git / blobdiff