PPI/Joins.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 Joins public header */
  25
  26 #ifndef HH_Joins_
  27 #define HH_Joins_ 1
  28
  29 // Custom includes
  30 #include <boost/ptr_container/ptr_vector.hpp>
  31 #include "predecl.hh"
  32 #include "Connectors.hh"
  33 #include "Module.hh"
  34
  35 //#include "Joins.mpp"
  36 ///////////////////////////////hh.p////////////////////////////////////////
  37
  38 namespace senf {
  39 namespace ppi {
  40
  41 #ifndef DOXYGEN
  42
  43     template <class Source>
  44     connector::PassiveInput & connect(Source & source, module::PassiveJoin & target);
  45
  46     template <class Source>
  47     connector::ActiveInput & connect(Source & source, module::PriorityJoin & target);
  48
  49 #endif
  50
  51 namespace module {
  52
  53     class PassiveJoin
  54         : public Module
  55     {
  56         SENF_PPI_MODULE(PassiveJoin);
  57     public:
  58         connector::ActiveOutput output;
  59
  60         PassiveJoin();
  61
  62         template <class Source>
  63         connector::PassiveInput & connect(Source & source);
  64
  65     private:
  66         connector::PassiveInput & newInput();
  67
  68         void request(connector::PassiveInput & input);
  69         void onThrottle();
  70         void onUnthrottle();
  71
  72         typedef boost::ptr_vector<connector::PassiveInput> Inputs;
  73         Inputs inputs_;
  74     };
  75
  76     class PriorityJoin
  77         : public Module
  78     {
  79         SENF_PPI_MODULE(PriorityJoin);
  80     public:
  81         connector::PassiveOutput output;
  82
  83         PriorityJoin();
  84
  85         template <class Source>
  86         connector::ActiveInput & connect(Source & source);
  87
  88     private:
  89         connector::ActiveInput & newInput();
  90
  91         void request();
  92         void onThrottle();
  93         void onUnthrottle();
  94
  95         typedef boost::ptr_vector<connector::ActiveInput> Inputs;
  96         Inputs inputs_;
  97     };
  98
  99 }}}
 100
 101 ///////////////////////////////hh.e////////////////////////////////////////
 102 #include "Joins.cci"
 103 //#include "Joins.ct"
 104 #include "Joins.cti"
 105 #endif
 106
 107 \f
 108 // Local Variables:
 109 // mode: c++
 110 // fill-column: 100
 111 // comment-column: 40
 112 // c-file-style: "senf"
 113 // indent-tabs-mode: nil
 114 // ispell-local-dictionary: "american"
 115 // compile-command: "scons -u test"
 116 // End: