rate_limiter_token_bucket.h | Explore in Territory

// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_REPORTING_UTIL_RATE_LIMITER_TOKEN_BUCKET_H_
#define COMPONENTS_REPORTING_UTIL_RATE_LIMITER_TOKEN_BUCKET_H_

#include <cstddef>

#include "base/functional/bind.h"
#include "base/memory/weak_ptr.h"
#include "base/sequence_checker.h"
#include "base/task/sequenced_task_runner.h"
#include "base/time/time.h"
#include "components/reporting/util/rate_limiter_interface.h"

namespace reporting {

// Rate limiter implementation of the token bucket algorithm.

// A token bucket works by an imaginary bucket that is filled with tokens. The
// tokens represent the incoming events, and the bucket represents the system's
// capacity to accept them. The bucket has a fixed number of tokens, and new
// tokens are added to the bucket at a fixed rate, until the bucket is full.
//
// `max_level` is the maximum total size of events that can be in the bucket at
// any given time. `filling_time` represents the rate at which events are
// allowed to go through the bucket. `filling_period` indicates how often do
// we want to update the level (the more frequently we do it, the fewer tokens
// we add each time).
//
// When a new event arrives, its size is released from the bucket. If the bucket
// does not have enough tokens in it, the event is rejected. After that the
// bucket resumes filling in at the prescribed rate.
//
// The outcome is that the events are accepted at no more than the filling rate.
// It is simple and effective, but can be inefficient for bursty events.
//
class RateLimiterTokenBucket : public RateLimiterInterface { … };
}  // namespace reporting

#endif  // COMPONENTS_REPORTING_UTIL_RATE_LIMITER_TOKEN_BUCKET_H_
chromium/components/reporting/util/rate_limiter_token_bucket.h
