Packets/DefaultBundle: added EUI64Parser

[senf.git] / senf / Scheduler / TimerEventProxy.hh

diff --git a/senf/Scheduler/TimerEventProxy.hh b/senf/Scheduler/TimerEventProxy.hh
index 9d40e3d..d1fb5ad 100644 (file)
--- a/senf/Scheduler/TimerEventProxy.hh
+++ b/senf/Scheduler/TimerEventProxy.hh
@@ -27,26 +27,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 <boost/range/iterator_range.hpp>
+// Custom includes
 #include <boost/multi_index_container.hpp>
 #include <boost/multi_index/ordered_index.hpp>
 #include <boost/multi_index/member.hpp>
 
 #include <senf/Scheduler/ClockService.hh>
 #include <senf/Scheduler/TimerEvent.hh>
-#include <senf/Utils/Console/Node.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
+        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 +49,53 @@ namespace scheduler {
         host a big count of timers.
      */
     template<typename IdType>
-    class TimerEventProxy 
+    class TimerEventProxy
     {
     public:
-        ///////////////////////////////////////////////////////////////////////////
-        // Types
-        typedef boost::function<void(senf::ClockService::clock_type, IdType 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, IdType const &id, Callback cb);
-        ///< Add new deadline timer
-        bool remove(IdType const & id);
-        ///< Remove timer by given \a id.
-        std::vector<std::pair<senf::ClockService::clock_type, IdType> > list();
-        ///< Returns a vector of all active timers with timeout and id.
-        
+        typedef boost::function<void(ClockService::clock_type, IdType const &)> 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<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. */
     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<Timeout>,
-                    boost::multi_index::member<Entry, senf::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;
-
         typedef typename EntrySet_t::template index<Timeout>::type EntrySetByTimeout_t;
         typedef typename EntrySet_t::template index<Id>::type EntrySetById_t;
 
@@ -114,12 +103,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
+
+\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: