File: ukm_recorder_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 (54 lines) | stat: -rw-r--r-- 2,126 bytes parent folder | download | duplicates (10)
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_UKM_UKM_RECORDER_OBSERVER_H_
#define COMPONENTS_UKM_UKM_RECORDER_OBSERVER_H_

#include <vector>

#include "base/observer_list_types.h"
#include "components/ukm/ukm_consent_state.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
#include "services/metrics/public/mojom/ukm_interface.mojom.h"
#include "url/gurl.h"

namespace ukm {

// Base class for observing UkmRecorderImpl. This object is notified when
// a new UKM entry is added, or when a source URL is updated, or when
// entries are purged. Observers are notified even if |recording_enabled_| is
// false. All the methods are notified on the same SequencedTaskRunner
// on which the observer is added.
class COMPONENT_EXPORT(UKM_RECORDER) UkmRecorderObserver
    : public base::CheckedObserver {
 public:
  UkmRecorderObserver() = default;
  ~UkmRecorderObserver() override = default;
  UkmRecorderObserver(const UkmRecorderObserver&) = delete;
  UkmRecorderObserver& operator=(const UkmRecorderObserver&) = delete;

  // Called when a new UKM entry is added.
  virtual void OnEntryAdded(mojom::UkmEntryPtr entry);

  // Called when URLs are updated for a |source_id|.
  virtual void OnUpdateSourceURL(SourceId source_id,
                                 const std::vector<GURL>& urls);

  // Called when UKM entries related to the given URL scheme should be purged.
  virtual void OnPurgeRecordingsWithUrlScheme(const std::string& url_scheme);

  // Called when all UKM entries should be purged.
  virtual void OnPurge();

  // Called when the UKM consent state is changed in any way, for the new
  // state to take effect. |state| is the collection of accepted consent types.
  // Each consent type is true iff the client has granted this consent on
  // all their Chrome profiles and URL-keyed anonymized data collection is
  // enabled for all profiles.
  virtual void OnUkmAllowedStateChanged(UkmConsentState state);
};

}  // namespace ukm

#endif  // COMPONENTS_UKM_UKM_RECORDER_OBSERVER_H_