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
171
172
173
174
175
176
177
178
179
180
181
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROMEOS_DBUS_SHILL_DEVICE_CLIENT_H_
#define CHROMEOS_DBUS_SHILL_DEVICE_CLIENT_H_
#include <string>
#include "base/basictypes.h"
#include "base/callback.h"
#include "chromeos/chromeos_export.h"
#include "chromeos/dbus/dbus_client_implementation_type.h"
#include "chromeos/dbus/shill_client_helper.h"
namespace base {
class Value;
class DictionaryValue;
} // namespace base
namespace dbus {
class Bus;
class ObjectPath;
} // namespace dbus
namespace chromeos {
class ShillPropertyChangedObserver;
// ShillDeviceClient is used to communicate with the Shill Device service.
// All methods should be called from the origin thread which initializes the
// DBusThreadManager instance.
class CHROMEOS_EXPORT ShillDeviceClient {
public:
typedef ShillClientHelper::PropertyChangedHandler PropertyChangedHandler;
typedef ShillClientHelper::DictionaryValueCallback DictionaryValueCallback;
typedef ShillClientHelper::ErrorCallback ErrorCallback;
// Interface for setting up devices for testing.
// Accessed through GetTestInterface(), only implemented in the Stub Impl.
class TestInterface {
public:
virtual void AddDevice(const std::string& device_path,
const std::string& type,
const std::string& object_path) = 0;
virtual void RemoveDevice(const std::string& device_path) = 0;
virtual void ClearDevices() = 0;
virtual void SetDeviceProperty(const std::string& device_path,
const std::string& name,
const base::Value& value) = 0;
virtual std::string GetDevicePathForType(const std::string& type) = 0;
protected:
virtual ~TestInterface() {}
};
virtual ~ShillDeviceClient();
// Factory function, creates a new instance which is owned by the caller.
// For normal usage, access the singleton via DBusThreadManager::Get().
static ShillDeviceClient* Create(DBusClientImplementationType type,
dbus::Bus* bus);
// Adds a property changed |observer| for the device at |device_path|.
virtual void AddPropertyChangedObserver(
const dbus::ObjectPath& device_path,
ShillPropertyChangedObserver* observer) = 0;
// Removes a property changed |observer| for the device at |device_path|.
virtual void RemovePropertyChangedObserver(
const dbus::ObjectPath& device_path,
ShillPropertyChangedObserver* observer) = 0;
// Calls GetProperties method.
// |callback| is called after the method call finishes.
virtual void GetProperties(const dbus::ObjectPath& device_path,
const DictionaryValueCallback& callback) = 0;
// DEPRECATED DO NOT USE: Calls GetProperties method and blocks until the
// method call finishes. The caller is responsible to delete the result.
// Thie method returns NULL when method call fails.
//
// TODO(hashimoto): Refactor CrosGetDeviceNetworkList and remove this method.
// crosbug.com/29902
virtual base::DictionaryValue* CallGetPropertiesAndBlock(
const dbus::ObjectPath& device_path) = 0;
// Calls ProposeScan method.
// |callback| is called after the method call finishes.
virtual void ProposeScan(const dbus::ObjectPath& device_path,
const VoidDBusMethodCallback& callback) = 0;
// Calls SetProperty method.
// |callback| is called after the method call finishes.
virtual void SetProperty(const dbus::ObjectPath& device_path,
const std::string& name,
const base::Value& value,
const base::Closure& callback,
const ErrorCallback& error_callback) = 0;
// Calls ClearProperty method.
// |callback| is called after the method call finishes.
virtual void ClearProperty(const dbus::ObjectPath& device_path,
const std::string& name,
const VoidDBusMethodCallback& callback) = 0;
// Calls AddIPConfig method.
// |callback| is called after the method call finishes.
virtual void AddIPConfig(const dbus::ObjectPath& device_path,
const std::string& method,
const ObjectPathDBusMethodCallback& callback) = 0;
// Calls the RequirePin method.
// |callback| is called after the method call finishes.
virtual void RequirePin(const dbus::ObjectPath& device_path,
const std::string& pin,
bool require,
const base::Closure& callback,
const ErrorCallback& error_callback) = 0;
// Calls the EnterPin method.
// |callback| is called after the method call finishes.
virtual void EnterPin(const dbus::ObjectPath& device_path,
const std::string& pin,
const base::Closure& callback,
const ErrorCallback& error_callback) = 0;
// Calls the UnblockPin method.
// |callback| is called after the method call finishes.
virtual void UnblockPin(const dbus::ObjectPath& device_path,
const std::string& puk,
const std::string& pin,
const base::Closure& callback,
const ErrorCallback& error_callback) = 0;
// Calls the ChangePin method.
// |callback| is called after the method call finishes.
virtual void ChangePin(const dbus::ObjectPath& device_path,
const std::string& old_pin,
const std::string& new_pin,
const base::Closure& callback,
const ErrorCallback& error_callback) = 0;
// Calls the Register method.
// |callback| is called after the method call finishes.
virtual void Register(const dbus::ObjectPath& device_path,
const std::string& network_id,
const base::Closure& callback,
const ErrorCallback& error_callback) = 0;
// Calls the SetCarrier method.
// |callback| is called after the method call finishes.
virtual void SetCarrier(const dbus::ObjectPath& device_path,
const std::string& carrier,
const base::Closure& callback,
const ErrorCallback& error_callback) = 0;
// Calls the Reset method.
// |callback| is called after the method call finishes.
virtual void Reset(const dbus::ObjectPath& device_path,
const base::Closure& callback,
const ErrorCallback& error_callback) = 0;
// Returns an interface for testing (stub only), or returns NULL.
virtual TestInterface* GetTestInterface() = 0;
protected:
// Create() should be used instead.
ShillDeviceClient();
private:
DISALLOW_COPY_AND_ASSIGN(ShillDeviceClient);
};
} // namespace chromeos
#endif // CHROMEOS_DBUS_SHILL_DEVICE_CLIENT_H_
|
