PPI/Queueing.hh

   1 // Copyright (C) 2007
   2 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   3 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   4 //     Stefan Bund <g0dil@berlios.de>
   5 //
   6 // This program is free software; you can redistribute it and/or modify
   7 // it under the terms of the GNU General Public License as published by
   8 // the Free Software Foundation; either version 2 of the License, or
   9 // (at your option) any later version.
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the
  18 // Free Software Foundation, Inc.,
  19 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  20
  21 /** \file
  22     \brief Queueing public header */
  23
  24 #ifndef HH_Queueing_
  25 #define HH_Queueing_ 1
  26
  27 // Custom includes
  28 #include "predecl.hh"
  29
  30 //#include "Queueing.mpp"
  31 ///////////////////////////////hh.p////////////////////////////////////////
  32
  33 namespace senf {
  34 namespace ppi {
  35
  36     /** \brief Queueing discipline base class
  37
  38         QueueingDescipline derived classes define the generation of throttling notifications. The
  39         QueueingDiscipline is called whenever the packets are entered or removed from the queue. The
  40         queueing discipline then determines the new throttling state of the queue.
  41
  42         \note The QueueingDiscipline will \e never drop packets explicitly. This is left to the
  43         operating system by sending throttling events. The PPI will never loose a packet internally
  44         (if not a module explicitly does so), however it may disable reception of new incoming
  45         packets which will then probably be dropped by the operating system.
  46      */
  47     class QueueingDiscipline
  48     {
  49     public:
  50         virtual ~QueueingDiscipline();
  51
  52         enum Event { ENQUEUE, DEQUEUE }; ///< Possible queueing events
  53         enum State { THROTTLED, UNTHROTTLED }; ///< Possible queueing states
  54
  55         virtual State update(connector::PassiveInput & input, Event event) = 0;
  56                                         ///< Calculate new queueing state
  57                                         /**< Whenever the queue is manipulated, this member is
  58                                              called to calculate the new throttling state.
  59
  60                                              \param[in] input Connector holding the queue
  61                                              \param[in] event Type of event triggering the update
  62                                              \returns new throttling state */
  63     };
  64
  65 }}
  66
  67 ///////////////////////////////hh.e////////////////////////////////////////
  68 //#include "Queueing.cci"
  69 //#include "Queueing.ct"
  70 //#include "Queueing.cti"
  71 #endif
  72
  73 \f
  74 // Local Variables:
  75 // mode: c++
  76 // fill-column: 100
  77 // c-file-style: "senf"
  78 // indent-tabs-mode: nil
  79 // ispell-local-dictionary: "american"
  80 // compile-command: "scons -u test"
  81 // comment-column: 40
  82 // End: