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
|
/*
* Copyright 2012 The WebRTC Project Authors. All rights reserved.
*
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
*/
#ifndef RTC_BASE_DATA_RATE_LIMITER_H_
#define RTC_BASE_DATA_RATE_LIMITER_H_
#include <stddef.h>
#include "rtc_base/system/rtc_export.h"
namespace webrtc {
// Limits the rate of use to a certain maximum quantity per period of
// time. Use, for example, for simple bandwidth throttling.
//
// It's implemented like a diet plan: You have so many calories per
// day. If you hit the limit, you can't eat any more until the next
// day.
class RTC_EXPORT DataRateLimiter {
public:
// For example, 100kb per second.
DataRateLimiter(size_t max, double period)
: max_per_period_(max),
period_length_(period),
used_in_period_(0),
period_start_(0.0),
period_end_(period) {}
virtual ~DataRateLimiter() {}
// Returns true if if the desired quantity is available in the
// current period (< (max - used)). Once the given time passes the
// end of the period, used is set to zero and more use is available.
bool CanUse(size_t desired, double time);
// Increment the quantity used this period. If past the end of a
// period, a new period is started.
void Use(size_t used, double time);
size_t used_in_period() const { return used_in_period_; }
size_t max_per_period() const { return max_per_period_; }
private:
size_t max_per_period_;
double period_length_;
size_t used_in_period_;
double period_start_;
double period_end_;
};
} // namespace webrtc
// Re-export symbols from the webrtc namespace for backwards compatibility.
// TODO(bugs.webrtc.org/4222596): Remove once all references are updated.
#ifdef WEBRTC_ALLOW_DEPRECATED_NAMESPACES
namespace rtc {
using ::webrtc::DataRateLimiter;
} // namespace rtc
#endif // WEBRTC_ALLOW_DEPRECATED_NAMESPACES
#endif // RTC_BASE_DATA_RATE_LIMITER_H_
|
