mirror of
https://github.com/mollyim/webrtc.git
synced 2025-05-13 05:40:42 +01:00
f9c5cf65f6
This removes a confusing name collision between webrtc::RateLimiter and rtc::RateLimiter where the header file names were separated only by an underscore. Bug: None Change-Id: Ifcf0a4e62b2bf3bd9057714d7c536f7609ad1b79 Reviewed-on: https://webrtc-review.googlesource.com/58741 Commit-Queue: Sebastian Jansson <srte@webrtc.org> Reviewed-by: Karl Wiberg <kwiberg@webrtc.org> Cr-Commit-Position: refs/heads/master@{#22237}
56 lines
1.8 KiB
C++
56 lines
1.8 KiB
C++
/*
|
|
* 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>
|
|
|
|
namespace rtc {
|
|
|
|
// 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 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 rtc
|
|
|
|
#endif // RTC_BASE_DATA_RATE_LIMITER_H_
|