7cbbeaf029d7e1ec0e95c4c58a696565cba985b1
[senf.git] / senf / PPI / detail / EventBinding.hh
1 // $Id$
2 //
3 // Copyright (C) 2007
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
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_SENF_PPI_detail_EventBinding_
27 #define HH_SENF_PPI_detail_EventBinding_ 1
28
29 // Custom includes
30 #include <senf/Scheduler/ClockService.hh>
31 #include <senf/PPI/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     /** \brief Internal: Association Event - Module - Handler, base-class */
42     class EventBindingBase
43     {
44     public:
45         ~EventBindingBase();
46
47         EventManager & manager() const;
48         module::Module & module() const;
49
50     protected:
51         EventBindingBase(EventManager & manager, module::Module & module,
52                          EventDescriptor & descriptor);
53
54         void eventTime(ClockService::clock_type time);
55
56     private:
57         EventManager * manager_;
58         module::Module * module_;
59         EventDescriptor * descriptor_;
60
61         friend class senf::ppi::EventManager;
62         friend class senf::ppi::EventDescriptor;
63     };
64
65     /** \brief Internal: Callback forwarders
66      */
67     template <class EventType, class Self>
68     class EventBindingHelper
69     {
70     public:
71         typedef typename detail::EventArgType<EventType>::type EventArg;
72
73         void callback(EventArg event, ClockService::clock_type time);
74         void callback(EventArg event);
75
76     private:
77         Self & self();
78     };
79
80 #ifndef DOXYGEN
81
82     template <class Self>
83     class EventBindingHelper<void,Self>
84     {
85     public:
86         void callback(ClockService::clock_type time);
87         void callback();
88
89     private:
90         Self & self();
91     };
92
93 #endif
94
95     /** \brief Internal: Association Event - Module - Handler, event type specific */
96     template <class EventType>
97     class EventBinding
98         : public EventBindingBase,
99           public EventBindingHelper<EventType, EventBinding<EventType> >
100     {
101     public:
102         typedef EventType Event;
103         typedef typename detail::EventArgType<Event>::type EventArg;
104         typedef typename detail::Callback<EventArg>::type Callback;
105
106         EventBinding(EventManager & manager, module::Module & module, Callback callback,
107                      EventDescriptor & descriptor);
108
109     private:
110         Callback callback_;
111
112         friend class EventBindingHelper<EventType, EventBinding<EventType> >;
113     };
114
115 }}}
116
117 ///////////////////////////////hh.e////////////////////////////////////////
118 #include "EventBinding.cci"
119 //#include "EventBinding.ct"
120 #include "EventBinding.cti"
121 #endif
122
123 \f
124 // Local Variables:
125 // mode: c++
126 // fill-column: 100
127 // comment-column: 40
128 // c-file-style: "senf"
129 // indent-tabs-mode: nil
130 // ispell-local-dictionary: "american"
131 // compile-command: "scons -u ../test"
132 // End: