File: metrics_lifecycle_observer.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 (57 lines) | stat: -rw-r--r-- 2,267 bytes parent folder | download | duplicates (8)
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
// 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_PAGE_LOAD_METRICS_BROWSER_METRICS_LIFECYCLE_OBSERVER_H_
#define COMPONENTS_PAGE_LOAD_METRICS_BROWSER_METRICS_LIFECYCLE_OBSERVER_H_

#include "components/page_load_metrics/browser/metrics_web_contents_observer.h"

#include "base/memory/raw_ptr.h"
#include "base/observer_list_types.h"
#include "content/public/browser/web_contents.h"

namespace page_load_metrics {

class PageLoadTracker;

// |MetricsLifecycleObserver| allows clients to observe lifecycle events for a
// given |MetricsWebContentsObserver|. It is only used in testing but will work
// as intended if used in production.
class MetricsLifecycleObserver : public base::CheckedObserver {
 public:
  explicit MetricsLifecycleObserver(content::WebContents* web_contents);

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

  ~MetricsLifecycleObserver() override;

  void OnGoingAway();

  // Some |PageLoadTiming| messages will race with the navigation commit.
  // |OnTrackerCreated()| allows client code to manipulate the
  // |PageLoadTracker| very early (eg, to add observers).
  virtual void OnTrackerCreated(PageLoadTracker* tracker) {}

  // In cases where |LoadTimingInfo| is not needed, waiting until commit is
  // fine.
  virtual void OnCommit(PageLoadTracker* tracker) {}

  // This is called both for prerender activation and restoration from
  // the back/forward cache.
  virtual void OnActivate(PageLoadTracker* tracker) {}

  // Returns the observer delegate for the committed load associated with
  // the |MetricsWebContentsObserver|, or null if the observer has gone away
  // (via MetricsWebContentsObserver::WebContentsDestroyed).
  const PageLoadMetricsObserverDelegate* GetDelegateForCommittedLoad();

 private:
  raw_ptr<MetricsWebContentsObserver> observer_;
};

}  // namespace page_load_metrics

#endif  // COMPONENTS_PAGE_LOAD_METRICS_BROWSER_METRICS_LIFECYCLE_OBSERVER_H_