webrtc_m130/webrtc/rtc_base/rate_limiter.h
kjellander e96c45b662 Reland "Update includes for webrtc/{base => rtc_base} rename (3/3)"
I used a command like this to update the paths:
perl -pi -e "s/webrtc\/base/webrtc\/rtc_base/g" `find webrtc/rtc_base -name "*.cc" -o -name "*.h"`

Changes since last attempt: Some system headers were moved back to their original location since on Windows compilation breaks otherwise.

BUG=webrtc:7634
NOTRY=True
NOPRESUBMIT=True
TBR=kwiberg@webrtc.org

Review-Url: https://codereview.webrtc.org/2966523003
Cr-Commit-Position: refs/heads/master@{#18868}
2017-06-30 17:45:21 +00:00

57 lines
1.8 KiB
C++

/*
* Copyright (c) 2016 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 WEBRTC_RTC_BASE_RATE_LIMITER_H_
#define WEBRTC_RTC_BASE_RATE_LIMITER_H_
#include <limits>
#include "webrtc/rtc_base/constructormagic.h"
#include "webrtc/rtc_base/criticalsection.h"
#include "webrtc/rtc_base/rate_statistics.h"
namespace webrtc {
class Clock;
// Class used to limit a bitrate, making sure the average does not exceed a
// maximum as measured over a sliding window. This class is thread safe; all
// methods will acquire (the same) lock befeore executing.
class RateLimiter {
public:
RateLimiter(const Clock* clock, int64_t max_window_ms);
~RateLimiter();
// Try to use rate to send bytes. Returns true on success and if so updates
// current rate.
bool TryUseRate(size_t packet_size_bytes);
// Set the maximum bitrate, in bps, that this limiter allows to send.
void SetMaxRate(uint32_t max_rate_bps);
// Set the window size over which to measure the current bitrate.
// For example, irt retransmissions, this is typically the RTT.
// Returns true on success and false if window_size_ms is out of range.
bool SetWindowSize(int64_t window_size_ms);
private:
const Clock* const clock_;
rtc::CriticalSection lock_;
RateStatistics current_rate_ GUARDED_BY(lock_);
int64_t window_size_ms_ GUARDED_BY(lock_);
uint32_t max_rate_bps_ GUARDED_BY(lock_);
RTC_DISALLOW_IMPLICIT_CONSTRUCTORS(RateLimiter);
};
} // namespace webrtc
#endif // WEBRTC_RTC_BASE_RATE_LIMITER_H_