X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FQueueing.hh;h=5ed6a9ff855923dd86603f152b306220350933b0;hb=a1fdb7bb122f0b05be809a922d4b7ef5e125fa67;hp=59e8e678fb6ed9b6d5754458c3d86432782e6ea3;hpb=f539f4271d470794a773a92bacd8ba086c9bc1cd;p=senf.git

diff --git a/PPI/Queueing.hh b/PPI/Queueing.hh
index 59e8e67..5ed6a9f 100644
--- a/PPI/Queueing.hh
+++ b/PPI/Queueing.hh
@@ -1,6 +1,8 @@
-// Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// $Id$
+//
+// Copyright (C) 2007
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
 //     Stefan Bund <g0dil@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
@@ -21,8 +23,8 @@
 /** \file
     \brief Queueing public header */
 
-#ifndef HH_Queueing_
-#define HH_Queueing_ 1
+#ifndef HH_SENF_PPI_Queueing_
+#define HH_SENF_PPI_Queueing_ 1
 
 // Custom includes
 #include "predecl.hh"
@@ -57,7 +59,7 @@ namespace ppi {
 
         enum Event { ENQUEUE, DEQUEUE }; ///< Possible queueing events
         
-        virtual void update(connector::PassiveInput & input, Event event) = 0;
+        virtual void update(connector::GenericPassiveInput & input, Event event) = 0;
                                         ///< Calculate new queueing state
                                         /**< Whenever the queue is manipulated, this member is
                                              called to calculate the new throttling state. The
@@ -68,13 +70,21 @@ namespace ppi {
                                              \param[in] event Type of event triggering the update */
     };
 
+    /** \brief Simple queueing discipline with high and low threshold
+
+        The ThresholdQueueing QueueingDiscipline is a simple queueing discipline which throttles the
+        input as soon the number of packets in the queue reaches the \a high threshold. The input
+        will be unthrottled when the number of packets drops to the \a low threshold. 
+
+        The default queueing discipline is ThresholdQueueing(1,0).
+     */
     class ThresholdQueueing
         : public QueueingDiscipline
     {
     public:
         ThresholdQueueing(unsigned high, unsigned low);
 
-        virtual void update(connector::PassiveInput & input, Event event);
+        virtual void update(connector::GenericPassiveInput & input, Event event);
 
     private:
         unsigned high_;