X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FScheduler%2FTimerEventProxy.hh;h=d9e0397c012cc10ffd1338382e5f973d64cc0587;hb=refs%2Fheads%2Fmaster;hp=08301ec306efaa8e4f7932d8c9cfa7d1a13354c2;hpb=4adca0eda1b26c8ca84421fd936f8450713ca6fd;p=senf.git

diff --git a/senf/Scheduler/TimerEventProxy.hh b/senf/Scheduler/TimerEventProxy.hh
index 08301ec..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 <mtk@berlios.de>
-//     Jens Moedeker <jens.moedeker@fokus.fraunhofer.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 */
@@ -34,15 +39,14 @@
 
 #include <senf/Scheduler/ClockService.hh>
 #include <senf/Scheduler/TimerEvent.hh>
-#include <senf/Utils/Console/Console.hh>
 
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 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.
 
@@ -50,27 +54,31 @@ namespace scheduler {
         host a big count of timers.
      */
     template<typename IdType>
-    class TimerEventProxy 
+    class TimerEventProxy
     {
     public:
         typedef boost::function<void(ClockService::clock_type, IdType const &)> Callback;
 
-        TimerEventProxy();              ///< Instantiate a TimerEventProxy
-        TimerEventProxy(std::string const & name, console::DirectoryNode & node);
-                                        /**< \brief Instantiate a TimerEventProxy and add the list
-                                                    command to the give DirectoryNode */
-        
+        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<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. */ 
+                                        /**< 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 {
@@ -90,11 +98,11 @@ namespace scheduler {
             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::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> 
+                    boost::multi_index::member<Entry, IdType, &Entry::id>
                 >
             >
         > EntrySet_t;
@@ -104,7 +112,7 @@ namespace scheduler {
         EntrySet_t entrySet;
         EntrySetById_t & entrySetById;
         EntrySetByTimeout_t & entrySetByTimeout;
-        
+
         scheduler::TimerEvent timer;
 
         void timerEvent();  // callback for the Scheduler timer event
@@ -112,7 +120,7 @@ namespace scheduler {
 
 }}
 
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 //#include "TimerEventProxy.cci"
 #include "TimerEventProxy.ct"
 //#include "TimerEventProxy.cti"