4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
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.
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.
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.
24 \brief Setup public header */
26 #ifndef HH_SENF_PPI_Setup_
27 #define HH_SENF_PPI_Setup_ 1
30 #include <boost/type_traits.hpp>
31 #include <boost/utility/enable_if.hpp>
34 //#include "Setup.mpp"
35 ///////////////////////////////hh.p////////////////////////////////////////
40 /** \brief Connect modules
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.
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.
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.
55 \throws connector::IncompatibleConnectorsException if the two connectors are not type
58 \see \ref ppi_connections
60 void connect(connector::GenericActiveOutput & source, connector::GenericPassiveInput & target);
62 /** \brief Connect modules
64 void connect(connector::GenericPassiveOutput & source, connector::GenericActiveInput & target);
68 template <class T, class C>
69 void connect(T & source, C & target,
70 typename boost::disable_if< boost::is_base_of<connector::Connector, T> >::type * = 0,
71 typename boost::enable_if< boost::is_base_of<connector::Connector, C> >::type * = 0);
73 template <class C, class T>
74 void connect(C & source, T & target,
75 typename boost::enable_if< boost::is_base_of<connector::Connector, C> >::type * = 0,
76 typename boost::disable_if< boost::is_base_of<connector::Connector,T> >::type * = 0);
78 template <class T1, class T2>
79 void connect(T1 & source, T2 & target,
80 typename boost::disable_if< boost::is_base_of<connector::Connector, T1> >::type * = 0,
81 typename boost::disable_if< boost::is_base_of<connector::Connector, T2> >::type * = 0);
85 /** \brief Start the network
87 Calling senf::ppi::run() will start processing the network. The main event loop is managed
88 by the Scheduler. Before starting the Scheduler main loop, all Module init() members are
91 senf::ppi::run() will return when no more work is to be done, that is when no events are
92 enabled (Since the events are enabled and disabled by the throttle notifications which
93 depend among other things on the packet queues, this is the same as checking for packets in
94 any queue). It is Ok to call senf::ppi::run() multiple times during the program lifetime.
100 /** \brief Manually initialize the network
102 For debugging purposes, it is sometimes simpler to not use senf::ppi::run() but instead
103 drive the network via explicit calls using the debug modules. However, it is still necessary
104 to initialize the network. This operation is performed by senf::ppi::init().
110 ///////////////////////////////hh.e////////////////////////////////////////
112 //#include "Setup.ct"
120 // comment-column: 40
121 // c-file-style: "senf"
122 // indent-tabs-mode: nil
123 // ispell-local-dictionary: "american"
124 // compile-command: "scons -u test"