switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Scheduler / FdManager.hh
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 FdManager public header */
30
31 #ifndef HH_SENF_Scheduler_FdManager_
32 #define HH_SENF_Scheduler_FdManager_ 1
33
34 // Custom includes
35 #include "Poller.hh"
36 #include "ClockService.hh"
37 #include <senf/Utils/singleton.hh>
38
39 //#include "FdManager.mpp"
40 //-/////////////////////////////////////////////////////////////////////////////////////////////////
41
42 namespace senf {
43 namespace scheduler {
44
45     void restart();
46
47 namespace detail {
48
49     class FdManager
50         : public singleton<FdManager>
51     {
52     public:
53         ///< Event baseclass
54         struct Event {
55             virtual ~Event();
56             virtual void signal(int events) = 0; ///< Called when the given event is posted
57         };
58
59         enum Events {
60             EV_READ = Poller<Event>::EV_READ, EV_PRIO = Poller<Event>::EV_PRIO, EV_WRITE = Poller<Event>::EV_WRITE,
61             EV_HUP = Poller<Event>::EV_HUP, EV_ERR = Poller<Event>::EV_ERR
62         };
63
64         using singleton<FdManager>::instance;
65         using singleton<FdManager>::alive;
66
67         bool set(int fd, int events, Event * entry);
68         void remove(int fd);
69
70         // Called by FileDispatcher
71         void timeout(int t);
72         int timeout() const;
73
74         void processOnce();             ///< Wait for events
75                                         /**< This call waits until at least one event is posted but
76                                              no longer than the current timeout(). */
77         ClockService::clock_type eventTime() const; ///< Time of last event
78
79     protected:
80
81     private:
82         FdManager();
83
84         Poller<Event> poller_;
85         senf::ClockService::clock_type eventTime_;
86
87         friend void senf::scheduler::restart();
88         friend class singleton<FdManager>;
89     };
90
91 }}}
92
93 //-/////////////////////////////////////////////////////////////////////////////////////////////////
94 #include "FdManager.cci"
95 //#include "FdManager.ct"
96 //#include "FdManager.cti"
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: