PPI: Remove specializations from documentation
[senf.git] / PPI / detail / EventBinding.hh
1 // $Id$
2 //
3 // Copyright (C) 2007 
4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
6 //     Stefan Bund <g0dil@berlios.de>
7 //
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22
23 /** \file
24     \brief EventBinding public header */
25
26 #ifndef HH_EventBinding_
27 #define HH_EventBinding_ 1
28
29 // Custom includes
30 #include "Scheduler/ClockService.hh"
31 #include "../predecl.hh"
32 #include "Callback.hh"
33
34 //#include "EventBinding.mpp"
35 ///////////////////////////////hh.p////////////////////////////////////////
36
37 namespace senf {
38 namespace ppi {
39 namespace detail {
40
41     class EventBindingBase
42     {
43     public:
44         ~EventBindingBase();
45
46         EventManager & manager() const;
47         module::Module & module() const;
48         
49     protected:
50         EventBindingBase(EventManager & manager, module::Module & module, 
51                          EventDescriptor & descriptor);
52
53         void eventTime(ClockService::clock_type time);
54
55     private:
56         EventManager * manager_;
57         module::Module * module_;
58         EventDescriptor * descriptor_;
59
60         friend class senf::ppi::EventManager;
61     };
62
63     template <class EventType, class Self>
64     class EventBindingHelper
65     {
66     public:
67         typedef typename detail::EventArgType<EventType>::type EventArg;
68
69         void callback(EventArg event, ClockService::clock_type time);
70         void callback(EventArg event);
71         
72     private:
73         Self & self();
74     };
75
76 #ifndef DOXYGEN
77
78     template <class Self>
79     class EventBindingHelper<void,Self>
80     {
81     public:
82         void callback(ClockService::clock_type time);
83         void callback();
84         
85     private:
86         Self & self();
87     };
88
89 #endif
90
91     template <class EventType>
92     class EventBinding
93         : public EventBindingBase, 
94           public EventBindingHelper<EventType, EventBinding<EventType> >
95     {
96     public:
97         typedef EventType Event;
98         typedef typename detail::EventArgType<Event>::type EventArg;
99         typedef typename detail::Callback<EventArg>::type Callback;
100
101         EventBinding(EventManager & manager, module::Module & module, Callback callback,
102                      EventDescriptor & descriptor);
103
104     private:
105         Callback callback_;
106
107         friend class EventBindingHelper<EventType, EventBinding<EventType> >;
108     };
109
110 }}}
111
112 ///////////////////////////////hh.e////////////////////////////////////////
113 #include "EventBinding.cci"
114 //#include "EventBinding.ct"
115 #include "EventBinding.cti"
116 #endif
117
118 \f
119 // Local Variables:
120 // mode: c++
121 // fill-column: 100
122 // comment-column: 40
123 // c-file-style: "senf"
124 // indent-tabs-mode: nil
125 // ispell-local-dictionary: "american"
126 // compile-command: "scons -u ../test"
127 // End: