switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Scheduler / IdleEvent.ih
1 // $Id$
2 //
3 // Copyright (C) 2009
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 IdleEvent internal header */
30
31 #ifndef IH_SENF_Scheduler_IdleEvent_
32 #define IH_SENF_Scheduler_IdleEvent_ 1
33
34 // Custom includes
35 #include <senf/Utils/singleton.hh>
36
37 //-/////////////////////////////////////////////////////////////////////////////////////////////////
38
39 namespace senf {
40 namespace scheduler {
41
42     void restart();
43
44 namespace detail {
45
46     class IdleEventDispatcher
47         : public singleton<IdleEventDispatcher>
48     {
49     public:
50         using singleton<IdleEventDispatcher>::instance;
51         using singleton<IdleEventDispatcher>::alive;
52
53         void add(IdleEvent & event);
54         void remove(IdleEvent & event);
55
56         void prepareRun();
57
58         // Called by PollTimerSource
59         void timeout(int t);
60         int timeout() const;
61
62         bool empty() const;
63
64     private:
65         IdleEventDispatcher();
66         ~IdleEventDispatcher();
67
68         typedef boost::intrusive::ilist<
69             IdleEventListBase::value_traits<IdleEvent>, false > EventList;
70
71         EventList events_;
72         int managerTimeout_;
73
74         friend void senf::scheduler::restart();
75         friend class singleton<IdleEventDispatcher>;
76     };
77
78 }}}
79
80 //-/////////////////////////////////////////////////////////////////////////////////////////////////
81 #endif
82
83 \f
84 // Local Variables:
85 // mode: c++
86 // fill-column: 100
87 // comment-column: 40
88 // c-file-style: "senf"
89 // indent-tabs-mode: nil
90 // ispell-local-dictionary: "american"
91 // compile-command: "scons -u test"
92 // End: