senf/PPI/ThrottleBarrier.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 ThrottleBarrier public header */
  25
  26 #ifndef HH_SENF_PPI_ThrottleBarrier_
  27 #define HH_SENF_PPI_ThrottleBarrier_ 1
  28
  29 // Custom includes
  30 #include "Connectors.hh"
  31 #include "Module.hh"
  32
  33 //#include "ThrottleBarrier.mpp"
  34 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  35
  36 namespace senf {
  37 namespace ppi {
  38 namespace module {
  39
  40     /** \brief Packet discarding barrier for throttle notifications
  41
  42         A ThrottleBarrier will \e not forward any throttle notifications received on it's output. It
  43         will instead discard any packet received on it's input while the output is throttled. This
  44         module is used to circumvent any operating system based queueing. This allows the queueing
  45         to be controlled explicitly within the PPI.
  46
  47         \ingroup routing_modules
  48      */
  49     class ThrottleBarrier
  50         : public Module
  51     {
  52         SENF_PPI_MODULE(ThrottleBarrier);
  53     public:
  54
  55         connector::PassiveInput<> input;
  56         connector::ActiveOutput<> output;
  57
  58         ThrottleBarrier();
  59
  60     private:
  61         void request();
  62     };
  63
  64
  65 }}}
  66
  67 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  68 //#include "ThrottleBarrier.cci"
  69 //#include "ThrottleBarrier.ct"
  70 //#include "ThrottleBarrier.cti"
  71 #endif
  72
  73 \f
  74 // Local Variables:
  75 // mode: c++
  76 // fill-column: 100
  77 // comment-column: 40
  78 // c-file-style: "senf"
  79 // indent-tabs-mode: nil
  80 // ispell-local-dictionary: "american"
  81 // compile-command: "scons -u test"
  82 // End: