switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Scheduler / TimerEvent.ih
1 // $Id$
2 //
3 // Copyright (C) 2008
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 //
6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
7 // Version 1.0 (the "License"); you may not use this file except in compliance
8 // with the License. You may obtain a copy of the License at 
9 // http://senf.berlios.de/license.html
10 //
11 // The Fraunhofer FOKUS Public License Version 1.0 is based on, 
12 // but modifies the Mozilla Public License Version 1.1.
13 // See the full license text for the amendments.
14 //
15 // Software distributed under the License is distributed on an "AS IS" basis, 
16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
17 // for the specific language governing rights and limitations under the License.
18 //
19 // The Original Code is Fraunhofer FOKUS code.
20 //
21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
23 // All Rights Reserved.
24 //
25 // Contributor(s):
26 //   Stefan Bund <g0dil@berlios.de>
27
28 /** \file
29     \brief TimerDispatcher internal header */
30
31 #ifndef IH_SENF_Scheduler_TimerEvent_
32 #define IH_SENF_Scheduler_TimerEvent_ 1
33
34 // Custom includes
35 #include <boost/scoped_ptr.hpp>
36 #include <senf/boost_intrusive/iset.hpp>
37 #include "TimerSource.hh"
38
39 //-/////////////////////////////////////////////////////////////////////////////////////////////////
40
41 namespace senf {
42 namespace scheduler {
43
44     void restart();
45
46 namespace detail {
47
48     struct TimerSetCompare {
49         bool operator()(TimerEvent const & a, TimerEvent const & b) const
50             { return a.timeout_ < b.timeout_; }
51     };
52
53     class TimerDispatcher
54         : public singleton<TimerDispatcher>
55     {
56         SENF_LOG_CLASS_AREA();
57
58     public:
59         using singleton<TimerDispatcher>::instance;
60         using singleton<TimerDispatcher>::alive;
61
62         void add(TimerEvent & event);
63         void remove(TimerEvent & event);
64
65         void enable();
66         void disable();
67
68         void prepareRun();
69         void reschedule();
70
71         bool empty() const;
72
73         void timerSource(std::auto_ptr<TimerSource> timerSource);
74         TimerSource * timerSource();
75
76     protected:
77
78     private:
79         TimerDispatcher();
80         ~TimerDispatcher();
81
82         typedef boost::intrusive::imultiset< TimerSetBase::value_traits<TimerEvent>,
83                                              TimerSetCompare,
84                                              false > TimerSet;
85
86         TimerSet timers_;
87
88         boost::scoped_ptr<TimerSource> source_;
89
90         friend void senf::scheduler::restart();
91         friend class singleton<TimerDispatcher>;
92     };
93
94 }}}
95
96 //-/////////////////////////////////////////////////////////////////////////////////////////////////
97 #endif
98
99 \f
100 // Local Variables:
101 // mode: c++
102 // fill-column: 100
103 // comment-column: 40
104 // c-file-style: "senf"
105 // indent-tabs-mode: nil
106 // ispell-local-dictionary: "american"
107 // compile-command: "scons -u test"
108 // End: