senf/PPI/PassiveQueue.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 PassiveQueue public header */
  25
  26 #ifndef HH_SENF_PPI_PassiveQueue_
  27 #define HH_SENF_PPI_PassiveQueue_ 1
  28
  29 // Custom includes
  30 #include "Connectors.hh"
  31 #include "Module.hh"
  32 #include "predecl.hh"
  33
  34 //#include "PassiveQueue.mpp"
  35 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  36
  37 namespace senf {
  38 namespace ppi {
  39 namespace module {
  40
  41     /** \brief Adaptor to connect active a pair of active connectors.
  42
  43         This adaptor queue is used to connect two active connectors to each other. The queue
  44         receives data in it's passive input and places them in it's queue. Whenever data is
  45         requested from the passive output, a packet is dequeued.
  46
  47         The PassiveQueue will automatically throttle in both directions. Throttling on the input
  48         connector is the standard throttling as implemented in
  49         connector::PassiveInput<>. Additional forward throttling notifications are sent out
  50         whenever the queue is empty.
  51
  52         \ingroup adapter_modules
  53      */
  54     class PassiveQueue
  55         : public module::Module
  56     {
  57         SENF_PPI_MODULE(PassiveQueue);
  58     public:
  59         connector::PassiveInput<> input;
  60         connector::PassiveOutput<> output;
  61
  62         PassiveQueue();
  63
  64         template <class QDiscipline>
  65         void qdisc(QDiscipline const & disc); ///< Change the queueing discipline
  66                                         /**< This call changes the queueing discipline of the
  67                                              queue. This call is just forwarded to the \a input
  68                                              connector.
  69
  70                                              \see connector::GenericPassiveInput::qdisc() */
  71
  72     private:
  73         virtual void v_init();
  74
  75         void onInput();
  76         void onOutput();
  77     };
  78
  79 }}}
  80
  81 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  82 #include "PassiveQueue.cci"
  83 //#include "PassiveQueue.ct"
  84 #include "PassiveQueue.cti"
  85 #endif
  86
  87 \f
  88 // Local Variables:
  89 // mode: c++
  90 // fill-column: 100
  91 // c-file-style: "senf"
  92 // indent-tabs-mode: nil
  93 // ispell-local-dictionary: "american"
  94 // compile-command: "scons -u test"
  95 // comment-column: 40
  96 // End: