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