PPI/Setup.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 Setup public header */
  25
  26 #ifndef HH_Setup_
  27 #define HH_Setup_ 1
  28
  29 // Custom includes
  30 #include <boost/type_traits.hpp>
  31 #include <boost/utility/enable_if.hpp>
  32 #include "predecl.hh"
  33
  34 //#include "Setup.mpp"
  35 ///////////////////////////////hh.p////////////////////////////////////////
  36
  37 namespace senf {
  38 namespace ppi {
  39
  40     /** \brief Connect modules
  41
  42         senf::ppi::connect() establishes a connection between two modules or, to be more precise,
  43         between two connectors. It will connect any input to any output connector as long as one is
  44         active and the other passive.
  45
  46         If a module has an output connector called \c output, the module may be directly specified
  47         as \a source argument. In the same way, if a module has an input connector called \c input,
  48         the module may be given directly as \a target argument. This simplifies the most common case
  49         of a module with one input and one output connector.
  50
  51         The connect call will check at runtime, whether the two connectors are type-compatible:
  52         \li Either or both of the connectors are untyped (they accept/send arbitrary senf::Packet's)
  53         \li Both connectors send/accept the exactly same packet type.
  54
  55         \throws IncompatibleConnectorsException if the two connectors are not type compatible.
  56
  57         \see \ref ppi_connections
  58      */
  59     void connect(connector::GenericActiveOutput & source, connector::GenericPassiveInput & target);
  60
  61     /** \brief Connect modules
  62         \see connect() */
  63     void connect(connector::GenericPassiveOutput & source, connector::GenericActiveInput & target);
  64
  65 #ifndef DOXYGEN
  66
  67     template <class T, class C>
  68     void connect(T & source, C & target,
  69                  typename boost::disable_if< boost::is_base_of<connector::Connector, T> >::type * = 0,
  70                  typename boost::enable_if< boost::is_base_of<connector::Connector, C> >::type * = 0);
  71
  72     template <class C, class T>
  73     void connect(C & source, T & target,
  74                  typename boost::enable_if< boost::is_base_of<connector::Connector, C> >::type * = 0,
  75                  typename boost::disable_if< boost::is_base_of<connector::Connector,T> >::type * = 0);
  76
  77     template <class T1, class T2>
  78     void connect(T1 & source, T2 & target,
  79                  typename boost::disable_if< boost::is_base_of<connector::Connector, T1> >::type * = 0,
  80                  typename boost::disable_if< boost::is_base_of<connector::Connector, T2> >::type * = 0);
  81
  82 #endif
  83
  84     /** \brief Start the network
  85
  86         Calling senf::ppi::run() will start processing the network. The main event loop is managed
  87         by the Scheduler. Before starting the Scheduler main loop, all Module init() members are
  88         called.
  89
  90         senf::ppi::run() will return when no more work is to be done, that is when no events are
  91         enabled (Since the events are enabled and disabled by the throttle notifications which
  92         depend among other things on the packet queues, this is the same as checking for packets in
  93         any queue). It is Ok to call senf::ppi::run() multiple times during the program lifetime.
  94
  95         \see \ref ppi_run
  96      */
  97     void run();
  98
  99     /** \brief Manually initialize the network
 100
 101         For debugging purposes, it is sometimes simpler to not use senf::ppi::run() but instead
 102         drive the network via explicit calls using the debug modules. However, it is still necessary
 103         to initialize the network. This operation is performed by senf::ppi::init().
 104      */
 105     void init();
 106
 107 }}
 108
 109 ///////////////////////////////hh.e////////////////////////////////////////
 110 #include "Setup.cci"
 111 //#include "Setup.ct"
 112 #include "Setup.cti"
 113 #endif
 114
 115 \f
 116 // Local Variables:
 117 // mode: c++
 118 // fill-column: 100
 119 // comment-column: 40
 120 // c-file-style: "senf"
 121 // indent-tabs-mode: nil
 122 // ispell-local-dictionary: "american"
 123 // compile-command: "scons -u test"
 124 // End: