PPI/EventManager.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 EventManager public header */
  25
  26 #ifndef HH_EventManager_
  27 #define HH_EventManager_ 1
  28
  29 // Custom includes
  30 #include <boost/ptr_container/ptr_vector.hpp>
  31 #include "Scheduler/ClockService.hh"
  32 #include "predecl.hh"
  33 #include "detail/Callback.hh"
  34 #include "detail/EventBinding.hh"
  35
  36 //#include "EventManager.mpp"
  37 ///////////////////////////////hh.p////////////////////////////////////////
  38
  39 namespace senf {
  40 namespace ppi {
  41
  42     /** \brief
  43       */
  44     class EventManager
  45     {
  46     public:
  47         ///////////////////////////////////////////////////////////////////////////
  48         // Types
  49
  50         template <class Descriptor>
  51 #ifndef DOXYGEN
  52         struct Callback
  53 #else
  54         // This is SO stupid but doxygen must have some scoping problems if the
  55         // struct is called 'Callback' and will hang in an endless loop somewhere
  56         struct Callback_
  57 #endif
  58             : public detail::Callback<typename Descriptor::EventArg>
  59         {};
  60
  61         ///////////////////////////////////////////////////////////////////////////
  62         ///\name Structors and default members
  63         ///@{
  64
  65         static EventManager & instance();
  66
  67         // default default constructor
  68         // default copy constructor
  69         // default copy assignment
  70         // default destructor
  71
  72         // no conversion constructors
  73
  74         ///@}
  75         ///////////////////////////////////////////////////////////////////////////
  76
  77         template <class Descriptor>
  78         void registerEvent(module::Module & module,
  79                            typename Callback<Descriptor>::type callback,
  80                            Descriptor & descriptor);
  81
  82         ClockService::clock_type eventTime();
  83
  84     protected:
  85
  86     private:
  87         void destroyModule(module::Module & module);
  88
  89         typedef boost::ptr_vector<detail::EventBindingBase> EventRegistrations;
  90         EventRegistrations registrations_;
  91
  92         void eventTime(ClockService::clock_type time);
  93
  94         ClockService::clock_type eventTime_;
  95
  96         friend class detail::EventBindingBase;
  97         friend class module::Module;
  98     };
  99
 100 }}
 101
 102 ///////////////////////////////hh.e////////////////////////////////////////
 103 #include "EventManager.cci"
 104 #include "EventManager.ct"
 105 //#include "EventManager.cti"
 106 #endif
 107
 108 \f
 109 // Local Variables:
 110 // mode: c++
 111 // fill-column: 100
 112 // comment-column: 40
 113 // c-file-style: "senf"
 114 // indent-tabs-mode: nil
 115 // ispell-local-dictionary: "american"
 116 // compile-command: "scons -u test"
 117 // End: