1 // libTorrent - BitTorrent library
2 // Copyright (C) 2005-2011, Jari Sundell
3 //
4 // This program is free software; you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation; either version 2 of the License, or
7 // (at your option) any later version.
8 //
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with this program; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17 //
18 // In addition, as a special exception, the copyright holders give
19 // permission to link the code of portions of this program with the
20 // OpenSSL library under certain conditions as described in each
21 // individual source file, and distribute linked combinations
22 // including the two.
23 //
24 // You must obey the GNU General Public License in all respects for
25 // all of the code used other than OpenSSL.  If you modify file(s)
26 // with this exception, you may extend this exception to your version
27 // of the file(s), but you are not obligated to do so.  If you do not
28 // wish to do so, delete this exception statement from your version.
29 // If you delete this exception statement from all source files in the
30 // program, then also delete it here.
31 //
32 // Contact:  Jari Sundell <jaris@ifi.uio.no>
33 //
34 //           Skomakerveien 33
35 //           3185 Skoppum, NORWAY
36 
37 #ifndef LIBTORRENT_NET_THROTTLE_INTERNAL_H
38 #define LIBTORRENT_NET_THROTTLE_INTERNAL_H
39 
40 #include <vector>
41 #include <rak/priority_queue_default.h>
42 
43 #include "torrent/common.h"
44 #include "torrent/throttle.h"
45 
46 namespace torrent {
47 
48 class ThrottleInternal : public Throttle {
49 public:
50   static const int flag_none = 0;
51   static const int flag_root = 1;
52 
53   ThrottleInternal(int flags);
54   ~ThrottleInternal();
55 
56   ThrottleInternal*   create_slave();
57 
is_root()58   bool                is_root()         { return m_flags & flag_root; }
59 
60   void                enable();
61   void                disable();
62 
63 private:
64   // Fraction is a fixed-precision value with the given number of bits after the decimal point.
65   static const uint32_t fraction_bits = 16;
66   static const uint32_t fraction_base = (1 << fraction_bits);
67 
68   typedef std::vector<ThrottleInternal*>  SlaveList;
69 
70   void                receive_tick();
71 
72   // Distribute quota, return amount of quota used. May be negative
73   // if it had more unused quota than is now allowed.
74   int32_t             receive_quota(uint32_t quota, uint32_t fraction);
75 
76   int                 m_flags;
77   SlaveList           m_slaveList;
78   SlaveList::iterator m_nextSlave;
79 
80   uint32_t            m_unusedQuota;
81 
82   rak::timer          m_timeLastTick;
83   rak::priority_item  m_taskTick;
84 };
85 
86 }
87 
88 #endif
89