PPI/Events.hh

   1 // Copyright (C) 2007
   2 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   3 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   4 //     Stefan Bund <g0dil@berlios.de>
   5 //
   6 // This program is free software; you can redistribute it and/or modify
   7 // it under the terms of the GNU General Public License as published by
   8 // the Free Software Foundation; either version 2 of the License, or
   9 // (at your option) any later version.
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the
  18 // Free Software Foundation, Inc.,
  19 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  20
  21 /** \file
  22     \brief Events public header */
  23
  24 #ifndef HH_Events_
  25 #define HH_Events_ 1
  26
  27 // Custom includes
  28 #include <boost/date_time/posix_time/posix_time_types.hpp>
  29 #include "predecl.hh"
  30
  31 //#include "Events.mpp"
  32 ///////////////////////////////hh.p////////////////////////////////////////
  33
  34 namespace senf {
  35 namespace ppi {
  36
  37     // Implementation: The concrete EventDescriptor implementation will need to set things up so
  38     // some callback (within the EventDescriptor implementation) will be called when the event
  39     // happens. This setup happens in 'v_enable()'. This internal handler sets up an EventType
  40     // instance if needed and calls 'callback()'.
  41     //
  42     // 'callback()' will access the EventBinding wrapper to find the user-callback to signal. It
  43     // will do any needed internal processing, call that user callback and clean up afterwards.
  44
  45     /** \brief Generic event interface baseclass
  46
  47         The EventDescriptor baseclass provides an interface to manipulate events in a generic
  48         way. This allows to register events or to temporarily disable event processing.
  49      */
  50     class EventDescriptor
  51     {
  52     public:
  53         virtual ~EventDescriptor();
  54
  55         bool enabled(); ///< Check, whether the event is currently enabled
  56         void enabled(bool v); ///< Enable or disable the event
  57
  58     protected:
  59         EventDescriptor();
  60
  61     private:
  62         virtual void v_enable() = 0;    ///< Called to enable the event delivery
  63         virtual void v_disable() = 0;   ///< Called to disable the event delivery
  64
  65         virtual bool v_isRegistered() = 0;
  66
  67         void notifyThrottle();
  68         void notifyUnthrottle();
  69
  70         bool enabled_;
  71
  72         friend class ForwardingRoute;
  73     };
  74
  75     template <class EventType, class Self>
  76     class EventImplementationHelper
  77     {
  78     protected:
  79         typedef typename detail::EventArgType<EventType>::type EventArg;
  80
  81         void callback(EventArg event, boost::posix_time::ptime time);
  82         void callback(EventArg event);
  83
  84     private:
  85         detail::EventBinding<EventType> & binding();
  86     };
  87
  88     template <class Self>
  89     class EventImplementationHelper<void,Self>
  90     {
  91     protected:
  92         void callback(boost::posix_time::ptime time);
  93         void callback();
  94
  95     private:
  96         detail::EventBinding<void> & binding();
  97     };
  98
  99     template <class EventType>
 100     class EventImplementation
 101         : public EventDescriptor,
 102           public EventImplementationHelper< EventType, EventImplementation<EventType> >
 103     {
 104     public:
 105         typedef EventType Event;
 106         typedef typename detail::EventArgType<EventType>::type EventArg;
 107
 108     protected:
 109         EventImplementation();
 110
 111     private:
 112         virtual bool v_isRegistered();
 113         void setBinding(detail::EventBinding<Event> & binding);
 114
 115         detail::EventBinding<Event> * binding_;
 116
 117         friend class EventManager;
 118         friend class EventImplementationHelper< EventType, EventImplementation<EventType> >;
 119     };
 120
 121 }}
 122
 123 ///////////////////////////////hh.e////////////////////////////////////////
 124 #include "Events.cci"
 125 //#include "Events.ct"
 126 #include "Events.cti"
 127 #endif
 128
 129 \f
 130 // Local Variables:
 131 // mode: c++
 132 // fill-column: 100
 133 // c-file-style: "senf"
 134 // indent-tabs-mode: nil
 135 // ispell-local-dictionary: "american"
 136 // compile-command: "scons -u test"
 137 // comment-column: 40
 138 // End: