senf/PPI/ThrottleBarrier.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   Stefan Bund <g0dil@berlios.de>
  27
  28 /** \file
  29     \brief ThrottleBarrier public header */
  30
  31 #ifndef HH_SENF_PPI_ThrottleBarrier_
  32 #define HH_SENF_PPI_ThrottleBarrier_ 1
  33
  34 // Custom includes
  35 #include "Connectors.hh"
  36 #include "Module.hh"
  37
  38 //#include "ThrottleBarrier.mpp"
  39 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  40
  41 namespace senf {
  42 namespace ppi {
  43 namespace module {
  44
  45     /** \brief Packet discarding barrier for throttle notifications
  46
  47         A ThrottleBarrier will \e not forward any throttle notifications received on it's output. It
  48         will instead discard any packet received on it's input while the output is throttled. This
  49         module is used to circumvent any operating system based queueing. This allows the queueing
  50         to be controlled explicitly within the PPI.
  51
  52         \ingroup routing_modules
  53      */
  54     class ThrottleBarrier
  55         : public Module
  56     {
  57         SENF_PPI_MODULE(ThrottleBarrier);
  58     public:
  59
  60         connector::PassiveInput<> input;
  61         connector::ActiveOutput<> output;
  62
  63         ThrottleBarrier();
  64
  65     private:
  66         void request();
  67     };
  68
  69
  70 }}}
  71
  72 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  73 //#include "ThrottleBarrier.cci"
  74 //#include "ThrottleBarrier.ct"
  75 //#include "ThrottleBarrier.cti"
  76 #endif
  77
  78 \f
  79 // Local Variables:
  80 // mode: c++
  81 // fill-column: 100
  82 // comment-column: 40
  83 // c-file-style: "senf"
  84 // indent-tabs-mode: nil
  85 // ispell-local-dictionary: "american"
  86 // compile-command: "scons -u test"
  87 // End: