PPI/ModuleManager.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 ModuleManager public header */
  25
  26 #ifndef HH_ModuleManager_
  27 #define HH_ModuleManager_ 1
  28
  29 // Custom includes
  30 #include <vector>
  31 #include "predecl.hh"
  32
  33 //#include "ModuleManager.mpp"
  34 ///////////////////////////////hh.p////////////////////////////////////////
  35
  36 namespace senf {
  37 namespace ppi {
  38
  39     /** \brief Internal: Module management
  40
  41         Every module is registered with the ModuleManager. The ModuleManager controls module
  42         initialization and execution of the network.
  43       */
  44     class ModuleManager
  45     {
  46     public:
  47         ///////////////////////////////////////////////////////////////////////////
  48         ///\name Structors and default members
  49         ///@{
  50
  51         static ModuleManager & instance();
  52
  53         // default default constructor
  54         // default copy constructor
  55         // default copy assignment
  56         // default destructor
  57
  58         // no conversion constructors
  59
  60         ///@}
  61         ///////////////////////////////////////////////////////////////////////////
  62
  63         void init();                    ///< Called by senf::ppi::init()
  64         void run();                     ///< Called by senf::ppi::run()
  65
  66         bool running() const;           ///< \c true, if the network is running
  67
  68     private:
  69         ModuleManager();
  70
  71         void registerModule(module::Module & module);
  72         void unregisterModule(module::Module & module);
  73
  74         typedef std::vector<module::Module *> ModuleRegistry;
  75
  76 #ifndef DOXYGEN
  77         struct RunGuard;
  78         friend class RunGuard;
  79 #endif
  80
  81         ModuleRegistry moduleRegistry_;
  82         bool running_;
  83         bool terminate_;
  84
  85         friend class module::Module;
  86     };
  87
  88
  89 }}
  90
  91 ///////////////////////////////hh.e////////////////////////////////////////
  92 #include "ModuleManager.cci"
  93 //#include "ModuleManager.ct"
  94 //#include "ModuleManager.cti"
  95 #endif
  96
  97 \f
  98 // Local Variables:
  99 // mode: c++
 100 // fill-column: 100
 101 // comment-column: 40
 102 // c-file-style: "senf"
 103 // indent-tabs-mode: nil
 104 // ispell-local-dictionary: "american"
 105 // compile-command: "scons -u test"
 106 // End: