src/net-limit/limitmanager.h

   1 /***************************************************************************
   2  *                                                                         *
   3  *   Copyright (C) 2006 David Brodsky                                      *
   4  *                                                                         *
   5  *   This library is free software; you can redistribute it and/or         *
   6  *   modify it under the terms of the GNU Library General Public           *
   7  *   License as published by the Free Software Foundation and appearing    *
   8  *   in the file LICENSE.LGPL included in the packaging of this file.      *
   9  *                                                                         *
  10  *   This library is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU      *
  13  *   Library General Public License for more details.                      *
  14  *                                                                         *
  15  ***************************************************************************/
  16
  17 #ifndef _tairon_net_limit_limitmanager_h
  18 #define _tairon_net_limit_limitmanager_h
  19
  20 #include <list>
  21 #include <set>
  22
  23 namespace Tairon
  24 {
  25
  26 namespace Net
  27 {
  28
  29 class Limiter;
  30 class Timer;
  31
  32 /** \brief LimitManager handles list of limiters that are waiting for free
  33  * bandwidth.
  34  */
  35 class LimitManager
  36 {
  37         public:
  38                 /** Creates a LimitManager object.
  39                  */
  40                 LimitManager();
  41
  42                 /** Destroys the manager.
  43                  */
  44                 ~LimitManager();
  45
  46                 /** Removes a limiter from the list.
  47                  */
  48                 void removeFromQueue(Limiter *l);
  49
  50                 /** Returns pointer the instance of this class.
  51                  */
  52                 static LimitManager *self() {
  53                         return limitmanager;
  54                 };
  55
  56                 /** Adds a limiter to the list.
  57                  */
  58                 void wantMore(Limiter *l);
  59
  60         private:
  61                 /** Called every second by a timer.
  62                  */
  63                 void timeout();
  64
  65         private:
  66                 /** Pointer to the instance of this class.
  67                  */
  68                 static LimitManager *limitmanager;
  69
  70                 /** Obe second timer.
  71                  */
  72                 Timer *timer;
  73
  74                 /** List of limiters that are about to be deleted from the queue.
  75                  */
  76                 std::list<Limiter *> toDelete;
  77
  78                 /** List of waiting limiters.
  79                  */
  80                 std::set<Limiter *> waiting;
  81 };
  82
  83 }; // namespace Net
  84
  85 }; // namespace Tairon
  86
  87 #endif
  88
  89 // vim: ai sw=4 ts=4 noet fdm=marker