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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
// 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 CHROMEOS_ASH_COMPONENTS_DBUS_PATCHPANEL_PATCHPANEL_CLIENT_H_
#define CHROMEOS_ASH_COMPONENTS_DBUS_PATCHPANEL_PATCHPANEL_CLIENT_H_
#include "base/component_export.h"
#include "base/functional/callback.h"
#include "base/observer_list_types.h"
#include "chromeos/ash/components/dbus/patchpanel/patchpanel_service.pb.h"
#include "chromeos/dbus/common/dbus_client.h"
#include "dbus/object_proxy.h"
namespace ash {
// Simple wrapper around patchpanel DBus API. The method names and protobuf
// schema used by patchpanel DBus API are defined in
// third_party/cros_system_api/dbus/patchpanel.
class COMPONENT_EXPORT(PATCHPANEL) PatchPanelClient
: public chromeos::DBusClient {
public:
class Observer : public base::CheckedObserver {
public:
// Called when NetworkConfigurationChanged signal is received, when the
// there is a network configuration change.
virtual void NetworkConfigurationChanged() {}
};
using GetDevicesCallback = base::OnceCallback<void(
const std::vector<patchpanel::NetworkDevice>& devices)>;
using TagSocketCallback = base::OnceCallback<void(bool success)>;
// The VPN routing policy which can be configured with TagSocket().
// DEFAULT_ROUTING is omitted here and std::nullopt should be used instead.
enum class VpnRoutingPolicy {
kRouteOnVpn,
kBypassVpn,
};
// Creates and initializes the global instance. |bus| must not be null.
static void Initialize(dbus::Bus* bus);
// Creates the global instance with a fake implementation.
static void InitializeFake();
// Destroys the global instance which must have been initialized first.
static void Shutdown();
// Returns the global instance if initialized. May return null.
static PatchPanelClient* Get();
PatchPanelClient(const PatchPanelClient&) = delete;
PatchPanelClient& operator=(const PatchPanelClient&) = delete;
// Obtains a list of virtual network interfaces configured and managed by
// patchpanel.
virtual void GetDevices(GetDevicesCallback callback) = 0;
// Called when power status of device is changed.
virtual void NotifyAndroidInteractiveState(bool interactive) = 0;
// Called when the status of Android WiFi multicast lock changes from held
// to not held or vice versa.
virtual void NotifyAndroidWifiMulticastLockChange(bool is_held) = 0;
// Called when notified of a new socket connection event.
virtual void NotifySocketConnectionEvent(
const patchpanel::SocketConnectionEvent& msg) = 0;
// Called when notified of a new socket connection event by an ARC VPN.
virtual void NotifyARCVPNSocketConnectionEvent(
const patchpanel::SocketConnectionEvent& msg) = 0;
// Tags this socket with |network_id| and |vpn_policy|. See the comments in
// third_party/cros_system_api/dbus/patchpanel/patchpanel_service.proto for
// their detailed meanings. The callback will be called once and only once
// after the current task is finished (i.e., via PostTask()).
virtual void TagSocket(int socket_fd,
std::optional<int> network_id,
std::optional<VpnRoutingPolicy> vpn_policy,
TagSocketCallback callback) = 0;
// Called when sending feature enabled flag to patchpanel.
virtual void SetFeatureFlag(
patchpanel::SetFeatureFlagRequest::FeatureFlag flag,
bool enabled) = 0;
// Calls |callback| when patchpanel DBus service to be available. If the
// service is already up, calls |callback| immediately.
virtual void WaitForServiceToBeAvailable(
dbus::ObjectProxy::WaitForServiceToBeAvailableCallback callback) = 0;
// Adds an observer.
virtual void AddObserver(Observer* observer) = 0;
// Removes an observer if added.
virtual void RemoveObserver(Observer* observer) = 0;
protected:
// Initialize/Shutdown should be used instead.
PatchPanelClient();
~PatchPanelClient() override;
};
} // namespace ash
#endif // CHROMEOS_ASH_COMPONENTS_DBUS_PATCHPANEL_PATCHPANEL_CLIENT_H_
|
