File: user_education_idle_observer.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (62 lines) | stat: -rw-r--r-- 2,131 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
55
56
57
58
59
60
61
62
// Copyright 2024 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_USER_EDUCATION_COMMON_SESSION_USER_EDUCATION_IDLE_OBSERVER_H_
#define COMPONENTS_USER_EDUCATION_COMMON_SESSION_USER_EDUCATION_IDLE_OBSERVER_H_

#include <optional>

#include "base/callback_list.h"
#include "base/functional/callback_forward.h"
#include "base/time/time.h"

namespace user_education {

class UserEducationTimeProvider;

// Used to observe the system/application idle state. Override virtual methods
// for testing.
class UserEducationIdleObserver {
 public:
  using UpdateCallback = base::RepeatingCallback<void(base::Time)>;

  UserEducationIdleObserver();
  UserEducationIdleObserver(const UserEducationIdleObserver&) = delete;
  void operator=(const UserEducationIdleObserver&) = delete;
  virtual ~UserEducationIdleObserver();

  // Called by UserEducationSessionManager to initialize required data members.
  void Init(const UserEducationTimeProvider* time_provider);

  // Start any observation that is required to detect idle state changes.
  // Default is no-op.
  virtual void StartObserving();

  // Returns a new last active time for the application if there is one;
  // `nullopt` otherwise.
  //
  // Should always return `nullopt` if the application is inactive, the system
  // is locked, etc.
  virtual std::optional<base::Time> MaybeGetNewLastActiveTime() const = 0;

  // Adds a callback to get when the last active time is updated.
  base::CallbackListSubscription AddUpdateCallback(
      UpdateCallback update_callback);

 protected:
  // Sends notifications that the last active time has changed.
  void NotifyLastActiveChanged(base::Time update);

  // Gets the current time from the current time source.
  base::Time GetCurrentTime() const;

 private:
  base::RepeatingCallbackList<typename UpdateCallback::RunType>
      update_callbacks_;
  raw_ptr<const UserEducationTimeProvider> time_provider_ = nullptr;
};

}  // namespace user_education

#endif  // COMPONENTS_USER_EDUCATION_COMMON_SESSION_USER_EDUCATION_IDLE_OBSERVER_H_