File: rate_limiter_interface.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (33 lines) | stat: -rw-r--r-- 1,178 bytes parent folder | download | duplicates (9) 
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
 
// 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_INTERFACE_H_
#define COMPONENTS_REPORTING_UTIL_RATE_LIMITER_INTERFACE_H_

#include <cstddef>

namespace reporting {

// Rate limiter expects the subclass to implement actual state and use it by
// calling `Acquire` to decide whether the event of `event_size` bytes can be
// posted, and if it can, update the state accordingly.
// Rate limiter instance is owned by the caller.
// Thread-unsafe, `Acquire` method needs to be called on sequence.
class RateLimiterInterface {
 public:
  RateLimiterInterface(const RateLimiterInterface&) = delete;
  RateLimiterInterface& operator=(const RateLimiterInterface&) = delete;

  virtual ~RateLimiterInterface() = default;

  // If the event is allowed, the method returns `true` and updates state to
  // prepare for the next call. Otherwise returns false.
  virtual bool Acquire(size_t event_size) = 0;

 protected:
  RateLimiterInterface() = default;
};
}  // namespace reporting

#endif  // COMPONENTS_REPORTING_UTIL_RATE_LIMITER_INTERFACE_H_