X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FScheduler%2FTimerEventProxy.hh;h=d9e0397c012cc10ffd1338382e5f973d64cc0587;hb=refs%2Fheads%2Fmaster;hp=9d40e3dd7e42ededc808c9bc255a73a91120cc26;hpb=2b2af7d62142f61f5804df2184b58e5f7ce3bd06;p=senf.git diff --git a/senf/Scheduler/TimerEventProxy.hh b/senf/Scheduler/TimerEventProxy.hh index 9d40e3d..d9e0397 100644 --- a/senf/Scheduler/TimerEventProxy.hh +++ b/senf/Scheduler/TimerEventProxy.hh @@ -2,24 +2,29 @@ // // Copyright (C) 2010 // Fraunhofer Institute for Open Communication Systems (FOKUS) -// Competence Center NETwork research (NET), St. Augustin, GERMANY -// Mathias Kretschmer -// Jens Moedeker // -// 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 +// Jens Moedeker /** \file \brief TimerEventProxy public header */ @@ -27,26 +32,21 @@ #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 +// Custom includes #include #include #include #include #include -#include +//-///////////////////////////////////////////////////////////////////////////////////////////////// namespace senf { namespace scheduler { /** \brief Deadline timer proxy - The TimerEventProxy is meant to host long term deadline timers to reduce the load of the + 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. @@ -54,59 +54,58 @@ namespace scheduler { host a big count of timers. */ template - class TimerEventProxy + class TimerEventProxy { public: - /////////////////////////////////////////////////////////////////////////// - // Types - typedef boost::function 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, IdType const &id, Callback cb); - ///< Add new deadline timer - bool remove(IdType const & id); - ///< Remove timer by given \a id. - std::vector > list(); - ///< Returns a vector of all active timers with timeout and id. + typedef boost::function Callback; + + 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 + + bool remove(IdType const & id); ///< Remove timer by given \a id. + + std::vector > 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 { - senf::ClockService::clock_type timeout; + ClockService::clock_type timeout; IdType id; Callback cb; - Entry(senf::ClockService::clock_type _timeout, IdType _id, Callback _cb) + Entry(ClockService::clock_type _timeout, IdType _id, Callback _cb) : timeout(_timeout), id(_id), cb(_cb) { } }; - - senf::scheduler::TimerEvent timer; - - // - // data structure to hold active timers - // struct Timeout {}; struct Id {}; #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, - boost::multi_index::member + boost::multi_index::member >, boost::multi_index::ordered_unique< boost::multi_index::tag, - boost::multi_index::member + boost::multi_index::member > > > EntrySet_t; - typedef typename EntrySet_t::template index::type EntrySetByTimeout_t; typedef typename EntrySet_t::template index::type EntrySetById_t; @@ -114,12 +113,26 @@ namespace scheduler { EntrySetById_t & entrySetById; EntrySetByTimeout_t & entrySetByTimeout; - // callback for the Scheduler timer event - void timerEvent(); + scheduler::TimerEvent timer; + + void timerEvent(); // callback for the Scheduler timer event }; -} -} -#include "TimerEventProxy.ct" +}} +//-///////////////////////////////////////////////////////////////////////////////////////////////// +//#include "TimerEventProxy.cci" +#include "TimerEventProxy.ct" +//#include "TimerEventProxy.cti" #endif + + +// 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: