File: background_sync_network_observer.h

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,122,156 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 (85 lines) | stat: -rw-r--r-- 3,155 bytes parent folder | download | duplicates (9)
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CONTENT_BROWSER_BACKGROUND_SYNC_BACKGROUND_SYNC_NETWORK_OBSERVER_H_
#define CONTENT_BROWSER_BACKGROUND_SYNC_BACKGROUND_SYNC_NETWORK_OBSERVER_H_

#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/sequence_checker.h"
#include "content/browser/background_sync/background_sync.pb.h"
#include "content/common/content_export.h"
#include "services/network/public/cpp/network_connection_tracker.h"

namespace content {

class CONTENT_EXPORT BackgroundSyncNetworkObserver
    : public network::NetworkConnectionTracker::NetworkConnectionObserver {
 public:
  // Creates a BackgroundSyncNetworkObserver. |network_changed_callback| is
  // called when the network connection changes asynchronously via PostMessage.
  BackgroundSyncNetworkObserver(
      base::RepeatingClosure network_changed_callback);

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

  ~BackgroundSyncNetworkObserver() override;

  // Does nothing in this class, but can be overridden to do some work
  // separately from the constructor.
  virtual void Init() {}

  // Enable or disable notifications coming from the NetworkConnectionTracker.
  // (For preventing flakes in tests)
  static void SetIgnoreNetworkChangesForTests(bool ignore);

  // Returns true if the network is online.
  bool NetworkSufficient();

  // NetworkConnectionObserver overrides
  void OnConnectionChanged(
      network::mojom::ConnectionType connection_type) override;

  // Allow tests to call NotifyManagerIfConnectionChanged.
  void NotifyManagerIfConnectionChangedForTesting(
      network::mojom::ConnectionType connection_type);

 private:
  // Finishes setup once we get the NetworkConnectionTracker from the UI thread.
  virtual void RegisterWithNetworkConnectionTracker(
      network::NetworkConnectionTracker* network_connection_tracker);

  // Update the current connection type from the NetworkConnectionTracker.
  void UpdateConnectionType();

  // Calls NotifyConnectionChanged if the connection type has changed.
  void NotifyManagerIfConnectionChanged(
      network::mojom::ConnectionType connection_type);

  void NotifyConnectionChanged();

  // NetworkConnectionTracker is a global singleton which will outlive this
  // object.
  raw_ptr<network::NetworkConnectionTracker> network_connection_tracker_;

  network::mojom::ConnectionType connection_type_;

  // The callback to run when the connection changes.
  base::RepeatingClosure connection_changed_callback_;

  // Set true to ignore notifications coming from the NetworkConnectionTracker
  // (to prevent flakes in tests).
  static bool ignore_network_changes_;

  SEQUENCE_CHECKER(sequence_checker_);

  base::WeakPtrFactory<BackgroundSyncNetworkObserver> weak_ptr_factory_{this};
};

}  // namespace content

#endif  // CONTENT_BROWSER_BACKGROUND_SYNC_BACKGROUND_SYNC_NETWORK_OBSERVER_H_