NEW FILE HEADER / COPYRIGHT FORMAT

[senf.git] / PPI / Queueing.hh

diff --git a/PPI/Queueing.hh b/PPI/Queueing.hh
index 59e8e67..8985c90 100644 (file)
--- a/PPI/Queueing.hh
+++ b/PPI/Queueing.hh
@@ -1,6 +1,6 @@
 // Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// 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
@@ -68,6 +68,14 @@ 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
     {