OLD | NEW |
1 /* | 1 /* |
2 * Copyright (c) 2016 The WebRTC project authors. All Rights Reserved. | 2 * Copyright (c) 2016 The WebRTC project authors. All Rights Reserved. |
3 * | 3 * |
4 * Use of this source code is governed by a BSD-style license | 4 * Use of this source code is governed by a BSD-style license |
5 * that can be found in the LICENSE file in the root of the source | 5 * that can be found in the LICENSE file in the root of the source |
6 * tree. An additional intellectual property rights grant can be found | 6 * tree. An additional intellectual property rights grant can be found |
7 * in the file PATENTS. All contributing project authors may | 7 * in the file PATENTS. All contributing project authors may |
8 * be found in the AUTHORS file in the root of the source tree. | 8 * be found in the AUTHORS file in the root of the source tree. |
9 */ | 9 */ |
10 | 10 |
11 #ifndef WEBRTC_BASE_RATE_LIMITER_H_ | 11 #ifndef WEBRTC_BASE_RATE_LIMITER_H_ |
12 #define WEBRTC_BASE_RATE_LIMITER_H_ | 12 #define WEBRTC_BASE_RATE_LIMITER_H_ |
13 | 13 |
14 #include <limits> | |
15 | 14 |
16 #include "webrtc/base/constructormagic.h" | 15 // This header is deprecated and is just left here temporarily during |
17 #include "webrtc/base/criticalsection.h" | 16 // refactoring. See https://bugs.webrtc.org/7634 for more details. |
18 #include "webrtc/base/rate_statistics.h" | 17 #include "webrtc/rtc_base/rate_limiter.h" |
19 | |
20 namespace webrtc { | |
21 | |
22 class Clock; | |
23 | |
24 // Class used to limit a bitrate, making sure the average does not exceed a | |
25 // maximum as measured over a sliding window. This class is thread safe; all | |
26 // methods will acquire (the same) lock befeore executing. | |
27 class RateLimiter { | |
28 public: | |
29 RateLimiter(const Clock* clock, int64_t max_window_ms); | |
30 ~RateLimiter(); | |
31 | |
32 // Try to use rate to send bytes. Returns true on success and if so updates | |
33 // current rate. | |
34 bool TryUseRate(size_t packet_size_bytes); | |
35 | |
36 // Set the maximum bitrate, in bps, that this limiter allows to send. | |
37 void SetMaxRate(uint32_t max_rate_bps); | |
38 | |
39 // Set the window size over which to measure the current bitrate. | |
40 // For example, irt retransmissions, this is typically the RTT. | |
41 // Returns true on success and false if window_size_ms is out of range. | |
42 bool SetWindowSize(int64_t window_size_ms); | |
43 | |
44 private: | |
45 const Clock* const clock_; | |
46 rtc::CriticalSection lock_; | |
47 RateStatistics current_rate_ GUARDED_BY(lock_); | |
48 int64_t window_size_ms_ GUARDED_BY(lock_); | |
49 uint32_t max_rate_bps_ GUARDED_BY(lock_); | |
50 | |
51 RTC_DISALLOW_IMPLICIT_CONSTRUCTORS(RateLimiter); | |
52 }; | |
53 | |
54 } // namespace webrtc | |
55 | 18 |
56 #endif // WEBRTC_BASE_RATE_LIMITER_H_ | 19 #endif // WEBRTC_BASE_RATE_LIMITER_H_ |
OLD | NEW |