1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
/*
* This file is part of the KFTPGrabber project
*
* Copyright (C) 2003-2007 by the KFTPGrabber developers
* Copyright (C) 2003-2007 Jernej Kos <kostko@jweb-network.net>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* is provided AS IS, WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, and
* NON-INFRINGEMENT. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Steet, Fifth Floor, Boston,
* MA 02110-1301, USA.
*
* In addition, as a special exception, the copyright holders give
* permission to link the code of portions of this program with the
* OpenSSL library under certain conditions as described in each
* individual source file, and distribute linked combinations
* including the two.
*
* You must obey the GNU General Public License in all respects
* for all of the code used other than OpenSSL. If you modify
* file(s) with this exception, you may extend this exception to your
* version of the file(s), but you are not obligated to do so. If you
* do not wish to do so, delete this exception statement from your
* version. If you delete this exception statement from all source
* files in the program, then also delete it here.
*/
#ifndef KFTPENGINESPEEDLIMITER_H
#define KFTPENGINESPEEDLIMITER_H
#include <ntqobject.h>
#include <ntqptrlist.h>
namespace KFTPEngine {
class SpeedLimiterItem;
/**
* This class is used by Socket implementations to enforce speed limits for
* uploads or downloads. It implements a variant of Token Bucket algorithm.
*
* @author Jernej Kos <kostko@unimatrix-one.org>
*/
class SpeedLimiter : public TQObject {
Q_OBJECT
public:
/**
* Possible limit types.
*/
enum Type {
Download = 0,
Upload = 1
};
/**
* Returns the global speed limiter instance.
*/
static SpeedLimiter *self();
/**
* Class destructor.
*/
~SpeedLimiter();
/**
* Set a limit rate.
*
* @param type Limit type
* @param limit Rate
*/
void setLimit(Type type, int limit);
/**
* Appends an item to be managed by the speed limiter.
*
* @param item Item instance
* @param type Limit type
*/
void append(SpeedLimiterItem *item, Type type);
/**
* Removes an item from the speed limiter.
*
* @param item Item instance
*/
void remove(SpeedLimiterItem *item);
/**
* Removes an item from the speed limiter.
*
* @param item Item instance
* @param type Limit type
*/
void remove(SpeedLimiterItem *item, Type type);
protected:
/**
* Static class instance.
*/
static SpeedLimiter *m_self;
/**
* Class constructor.
*/
SpeedLimiter();
/**
* Timer event.
*/
void timerEvent(TQTimerEvent*);
private:
bool m_timer;
int m_limits[2];
TQPtrList<SpeedLimiterItem> m_objects[2];
int m_tokenDebt[2];
private slots:
void updateLimits();
};
/**
* This class represents an item managed by the speed limiter. This is
* usually a socket.
*
* @author Jernej Kos <kostko@unimatrix-one.org>
*/
class SpeedLimiterItem {
friend class SpeedLimiter;
public:
/**
* Class constructor.
*/
SpeedLimiterItem();
/**
* Returns the number of bytes allowed for consumption.
*/
int allowedBytes() const { return m_availableBytes; }
protected:
/**
* Updates object's byte usage.
*/
void updateUsage(int bytes);
private:
int m_availableBytes;
};
}
#endif
|
