File: commit_quota.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 (54 lines) | stat: -rw-r--r-- 1,691 bytes parent folder | download | duplicates (6)
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
// Copyright 2022 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_SYNC_ENGINE_CYCLE_COMMIT_QUOTA_H_
#define COMPONENTS_SYNC_ENGINE_CYCLE_COMMIT_QUOTA_H_

#include "base/time/time.h"

namespace syncer {

// Tracks quota for commits with `max_tokens` being also the initial token
// count. A token is refilled every `refill_interval` if below the maximum token
// count. Tokens are consumed one by one by `ConsumeToken()` until they reach
// the zero. When having zero tokens, calls to `ConsumeToken()` only reset the
// refill "timer" (pushing away the next refill to happen after
// `refill_interval` from now).
class CommitQuota {
 public:
  CommitQuota(int max_tokens, base::TimeDelta refill_interval);

  CommitQuota(const CommitQuota&);
  CommitQuota& operator=(const CommitQuota&);
  CommitQuota(CommitQuota&&);
  CommitQuota& operator=(CommitQuota&&);

  ~CommitQuota();

  // Changes the current quota params to the values provided as arguments.
  void SetParams(int max_tokens, base::TimeDelta refill_interval);

  // Returns whether the current token count is greater than zero.
  bool HasTokensAvailable();

  // Consumes a token. If the current token count is zero, it only resets the
  // refill "timer".
  void ConsumeToken();

 private:
  // Refills any tokens and updates `last_refilled_` time if possible.
  void RefillTokens();

  // Params of the quota.
  int max_tokens_;
  base::TimeDelta refill_interval_;

  // Current state of the quota.
  int tokens_;
  base::TimeTicks last_refilled_;
};

}  // namespace syncer

#endif  // COMPONENTS_SYNC_ENGINE_CYCLE_COMMIT_QUOTA_H_