File: nudge_cap_tracker.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 (42 lines) | stat: -rw-r--r-- 1,372 bytes parent folder | download | duplicates (4)
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
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "base/containers/queue.h"
#include "base/time/time.h"

namespace contextual_cueing {

// Keeps track of timestamps of recent nudges for the sake of capping nudge
// count over a period of time. (i.e. x nudges per y hours). This queue is
// maintained such that it only has timestamps necessary to enforce the limits.
// Old timestamps will be trimmed.
class NudgeCapTracker {
 public:
  NudgeCapTracker(size_t cap_count, base::TimeDelta duration);

  NudgeCapTracker(const NudgeCapTracker&) = delete;
  NudgeCapTracker& operator=(const NudgeCapTracker&) = delete;

  NudgeCapTracker(NudgeCapTracker&& source);
  ~NudgeCapTracker();

  // Returns whether the nudge is eligible to be shown.
  bool CanShowNudge() const;

  // Notifies that the nudge was shown to user. This tracks the shown timestamps
  // for nudge cap calculation.
  void CueingNudgeShown();

  // Returns the time when the most recent nudge was shown.
  std::optional<base::TimeTicks> GetMostRecentNudgeTime() const;

 private:
  base::queue<base::TimeTicks> recent_nudge_timestamps_;

  // The nudge can be shown `cap_count_` times over `duration_`.
  const size_t cap_count_;
  const base::TimeDelta duration_;
};

}  // namespace contextual_cueing