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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
|
// Copyright 2012 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_SHILL_SHILL_CLIENT_HELPER_H_
#define CHROMEOS_ASH_COMPONENTS_DBUS_SHILL_SHILL_CLIENT_HELPER_H_
#include <memory>
#include <string>
#include <vector>
#include "base/functional/callback.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/observer_list.h"
#include "base/values.h"
#include "chromeos/ash/components/dbus/shill/shill_property_changed_observer.h"
#include "chromeos/dbus/common/dbus_callback.h"
namespace dbus {
class MessageWriter;
class MethodCall;
class ObjectProxy;
class Signal;
} // namespace dbus
namespace ash {
// A class to help implement Shill clients.
class ShillClientHelper {
public:
class RefHolder;
// A callback to handle responses of methods returning a `base::Value::List`.
using ListValueCallback =
base::OnceCallback<void(const base::Value::List& result)>;
// A callback to handle errors for method call.
using ErrorCallback =
base::OnceCallback<void(const std::string& error_name,
const std::string& error_message)>;
// A callback that handles responses for methods with string results.
using StringCallback = base::OnceCallback<void(const std::string& result)>;
// A callback that handles responses for methods with boolean results.
using BooleanCallback = base::OnceCallback<void(bool result)>;
// Callback used to notify owner when this can be safely released.
using ReleasedCallback = base::OnceCallback<void(ShillClientHelper* helper)>;
explicit ShillClientHelper(dbus::ObjectProxy* proxy);
ShillClientHelper(const ShillClientHelper&) = delete;
ShillClientHelper& operator=(const ShillClientHelper&) = delete;
virtual ~ShillClientHelper();
// Sets |released_callback_|. This is optional and should only be called at
// most once.
void SetReleasedCallback(ReleasedCallback callback);
// Adds an |observer| of the PropertyChanged signal.
void AddPropertyChangedObserver(ShillPropertyChangedObserver* observer);
// Removes an |observer| of the PropertyChanged signal.
void RemovePropertyChangedObserver(ShillPropertyChangedObserver* observer);
// Starts monitoring PropertyChanged signal. If there aren't observers for the
// PropertyChanged signal, the actual monitoring will be delayed until the
// first observer is added.
void MonitorPropertyChanged(const std::string& interface_name);
// Calls a method without results.
void CallVoidMethod(dbus::MethodCall* method_call,
chromeos::VoidDBusMethodCallback callback);
// Calls a method with an object path result where there is an error callback.
void CallObjectPathMethodWithErrorCallback(
dbus::MethodCall* method_call,
chromeos::ObjectPathCallback callback,
ErrorCallback error_callback);
// Calls a method with a value result.
void CallValueMethod(dbus::MethodCall* method_call,
chromeos::DBusMethodCallback<base::Value> callback);
// Calls a method with a value dictionary result.
void CallDictValueMethod(
dbus::MethodCall* method_call,
chromeos::DBusMethodCallback<base::Value::Dict> callback);
// Calls a method without results with error callback.
void CallVoidMethodWithErrorCallback(dbus::MethodCall* method_call,
base::OnceClosure callback,
ErrorCallback error_callback);
// Calls a method with a boolean result with error callback.
void CallBooleanMethodWithErrorCallback(dbus::MethodCall* method_call,
BooleanCallback callback,
ErrorCallback error_callback);
// Calls a method with a string result with error callback.
void CallStringMethodWithErrorCallback(dbus::MethodCall* method_call,
StringCallback callback,
ErrorCallback error_callback);
// Calls a method with a dictionary value result with error callback.
void CallDictValueMethodWithErrorCallback(
dbus::MethodCall* method_call,
base::OnceCallback<void(base::Value::Dict result)> callback,
ErrorCallback error_callback);
// Calls a method with a boolean array result with error callback.
void CallListValueMethodWithErrorCallback(dbus::MethodCall* method_call,
ListValueCallback callback,
ErrorCallback error_callback);
const dbus::ObjectProxy* object_proxy() const { return proxy_; }
// Appends the value to the writer as a variant. If |value| is a dictionary it
// will be written as a string -> variant dictionary, a{sv}. If |value| is a
// List then it will be written either as a List of String values, 'as', or a
// List of Dictionary values, 'aa{ss}', depending on the type of the values in
// the list.
static void AppendValueDataAsVariant(dbus::MessageWriter* writer,
const std::string& name,
const base::Value& value);
// Appends a string-to-variant dictionary to the writer as an '{sv}' array.
// Each value is written using AppendValueDataAsVariant.
static void AppendServiceProperties(dbus::MessageWriter* writer,
const base::Value::Dict& dictionary);
protected:
// Reference / Ownership management. If the number of active refs (observers
// + in-progress method calls) becomes 0, |released_callback_| (if set) will
// be called.
void AddRef();
void Release();
private:
// Starts monitoring PropertyChanged signal.
void MonitorPropertyChangedInternal(const std::string& interface_name);
// Handles the result of signal connection setup.
void OnSignalConnected(const std::string& interface,
const std::string& signal,
bool success);
// Handles PropertyChanged signal.
void OnPropertyChanged(dbus::Signal* signal);
raw_ptr<dbus::ObjectProxy> proxy_;
ReleasedCallback released_callback_;
int active_refs_;
base::ObserverList<ShillPropertyChangedObserver,
true /* check_empty */>::Unchecked observer_list_;
std::vector<std::string> interfaces_to_be_monitored_;
// Note: This should remain the last member so it'll be destroyed and
// invalidate its weak pointers before any other members are destroyed.
base::WeakPtrFactory<ShillClientHelper> weak_ptr_factory_{this};
};
} // namespace ash
#endif // CHROMEOS_ASH_COMPONENTS_DBUS_SHILL_SHILL_CLIENT_HELPER_H_
|
