File: rate_limiter_interface.h

package info (click to toggle)
chromium 145.0.7632.159-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 5,976,224 kB
  • sloc: cpp: 36,198,469; ansic: 7,634,080; javascript: 3,564,060; python: 1,649,622; xml: 838,470; asm: 717,087; pascal: 185,708; sh: 88,786; perl: 88,718; objc: 79,984; sql: 59,811; cs: 42,452; fortran: 24,101; makefile: 21,144; tcl: 15,277; php: 14,022; yacc: 9,066; ruby: 7,553; awk: 3,720; lisp: 3,233; lex: 1,328; ada: 727; jsp: 228; sed: 36
file content (33 lines) | stat: -rw-r--r-- 1,178 bytes parent folder | download | duplicates (12) 
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_