OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef DEVICE_BLUETOOTH_DBUS_BLUETOOTH_GATT_DESCRIPTOR_SERVICE_PROVIDER_H_ | 5 #ifndef DEVICE_BLUETOOTH_DBUS_BLUETOOTH_GATT_DESCRIPTOR_SERVICE_PROVIDER_H_ |
6 #define DEVICE_BLUETOOTH_DBUS_BLUETOOTH_GATT_DESCRIPTOR_SERVICE_PROVIDER_H_ | 6 #define DEVICE_BLUETOOTH_DBUS_BLUETOOTH_GATT_DESCRIPTOR_SERVICE_PROVIDER_H_ |
7 | 7 |
| 8 #include <stdint.h> |
| 9 |
8 #include <string> | 10 #include <string> |
9 #include <vector> | 11 #include <vector> |
10 | 12 |
11 #include "base/basictypes.h" | |
12 #include "base/callback.h" | 13 #include "base/callback.h" |
| 14 #include "base/macros.h" |
13 #include "dbus/bus.h" | 15 #include "dbus/bus.h" |
14 #include "dbus/object_path.h" | 16 #include "dbus/object_path.h" |
15 #include "device/bluetooth/bluetooth_export.h" | 17 #include "device/bluetooth/bluetooth_export.h" |
16 | 18 |
17 namespace bluez { | 19 namespace bluez { |
18 | 20 |
19 // BluetoothGattDescriptorServiceProvider is used to provide a D-Bus object that | 21 // BluetoothGattDescriptorServiceProvider is used to provide a D-Bus object that |
20 // represents a local GATT characteristic descriptor that the Bluetooth daemon | 22 // represents a local GATT characteristic descriptor that the Bluetooth daemon |
21 // can communicate with. | 23 // can communicate with. |
22 // | 24 // |
23 // Instantiate with a chosen D-Bus object path, delegate, and other fields. | 25 // Instantiate with a chosen D-Bus object path, delegate, and other fields. |
24 // The Bluetooth daemon communicates with a GATT descriptor using the | 26 // The Bluetooth daemon communicates with a GATT descriptor using the |
25 // standard DBus.Properties interface. While most properties of the GATT | 27 // standard DBus.Properties interface. While most properties of the GATT |
26 // descriptor interface are read-only and don't change throughout the | 28 // descriptor interface are read-only and don't change throughout the |
27 // life-time of the object, the "Value" property is both writeable and its | 29 // life-time of the object, the "Value" property is both writeable and its |
28 // value can change. Both Get and Set operations performed on the "Value" | 30 // value can change. Both Get and Set operations performed on the "Value" |
29 // property are delegated to the Delegate object, an instance of which is | 31 // property are delegated to the Delegate object, an instance of which is |
30 // mandatory during initialization. In addition, a "SendValueChanged" method is | 32 // mandatory during initialization. In addition, a "SendValueChanged" method is |
31 // provided, which emits a DBus.Properties.PropertyChanged signal for the | 33 // provided, which emits a DBus.Properties.PropertyChanged signal for the |
32 // "Value" property. | 34 // "Value" property. |
33 class DEVICE_BLUETOOTH_EXPORT BluetoothGattDescriptorServiceProvider { | 35 class DEVICE_BLUETOOTH_EXPORT BluetoothGattDescriptorServiceProvider { |
34 public: | 36 public: |
35 // Interface for reacting to GATT characteristic descriptor value requests. | 37 // Interface for reacting to GATT characteristic descriptor value requests. |
36 class Delegate { | 38 class Delegate { |
37 public: | 39 public: |
38 virtual ~Delegate() {} | 40 virtual ~Delegate() {} |
39 | 41 |
40 // ValueCallback is used for methods that require a descriptor value | 42 // ValueCallback is used for methods that require a descriptor value |
41 // to be returned. | 43 // to be returned. |
42 typedef base::Callback<void(const std::vector<uint8>&)> ValueCallback; | 44 typedef base::Callback<void(const std::vector<uint8_t>&)> ValueCallback; |
43 | 45 |
44 // ErrorCallback is used by methods to report failure. | 46 // ErrorCallback is used by methods to report failure. |
45 typedef base::Closure ErrorCallback; | 47 typedef base::Closure ErrorCallback; |
46 | 48 |
47 // This method will be called when a remote device requests to read the | 49 // This method will be called when a remote device requests to read the |
48 // value of the exported GATT descriptor. Invoke |callback| with a value | 50 // value of the exported GATT descriptor. Invoke |callback| with a value |
49 // to return that value to the requester. Invoke |error_callback| to report | 51 // to return that value to the requester. Invoke |error_callback| to report |
50 // a failure to read the value. This can happen, for example, if the | 52 // a failure to read the value. This can happen, for example, if the |
51 // descriptor has no read permission set. Either callback should be | 53 // descriptor has no read permission set. Either callback should be |
52 // invoked after a reasonable amount of time, since the request will time | 54 // invoked after a reasonable amount of time, since the request will time |
53 // out if left pending for too long. | 55 // out if left pending for too long. |
54 virtual void GetDescriptorValue(const ValueCallback& callback, | 56 virtual void GetDescriptorValue(const ValueCallback& callback, |
55 const ErrorCallback& error_callback) = 0; | 57 const ErrorCallback& error_callback) = 0; |
56 | 58 |
57 // This method will be called, when a remote device requests to write the | 59 // This method will be called, when a remote device requests to write the |
58 // value of the exported GATT descriptor. Invoke |callback| to report | 60 // value of the exported GATT descriptor. Invoke |callback| to report |
59 // that the value was successfully written. Invoke |error_callback| to | 61 // that the value was successfully written. Invoke |error_callback| to |
60 // report a failure to write the value. This can happen, for example, if the | 62 // report a failure to write the value. This can happen, for example, if the |
61 // descriptor has no write permission set. Either callback should be | 63 // descriptor has no write permission set. Either callback should be |
62 // invoked after a reasonable amount of time, since the request will time | 64 // invoked after a reasonable amount of time, since the request will time |
63 // out if left pending for too long. | 65 // out if left pending for too long. |
64 // | 66 // |
65 // The delegate should use this method to perform any side-effects that may | 67 // The delegate should use this method to perform any side-effects that may |
66 // occur based on the set value and potentially send a property changed | 68 // occur based on the set value and potentially send a property changed |
67 // signal to notify the Bluetooth daemon that the value has changed. | 69 // signal to notify the Bluetooth daemon that the value has changed. |
68 virtual void SetDescriptorValue(const std::vector<uint8>& value, | 70 virtual void SetDescriptorValue(const std::vector<uint8_t>& value, |
69 const base::Closure& callback, | 71 const base::Closure& callback, |
70 const ErrorCallback& error_callback) = 0; | 72 const ErrorCallback& error_callback) = 0; |
71 }; | 73 }; |
72 | 74 |
73 virtual ~BluetoothGattDescriptorServiceProvider(); | 75 virtual ~BluetoothGattDescriptorServiceProvider(); |
74 | 76 |
75 // Send a PropertyChanged signal to notify the Bluetooth daemon that the value | 77 // Send a PropertyChanged signal to notify the Bluetooth daemon that the value |
76 // of the "Value" property has changed to |value|. | 78 // of the "Value" property has changed to |value|. |
77 virtual void SendValueChanged(const std::vector<uint8>& value) = 0; | 79 virtual void SendValueChanged(const std::vector<uint8_t>& value) = 0; |
78 | 80 |
79 // Creates the instance, where |bus| is the D-Bus bus connection to export | 81 // Creates the instance, where |bus| is the D-Bus bus connection to export |
80 // the object onto, |uuid| is the 128-bit GATT descriptor UUID, |permissions| | 82 // the object onto, |uuid| is the 128-bit GATT descriptor UUID, |permissions| |
81 // is the list of attribute permissions, |characteristic_path| is the object | 83 // is the list of attribute permissions, |characteristic_path| is the object |
82 // path of the exported GATT characteristic the descriptor belongs to, | 84 // path of the exported GATT characteristic the descriptor belongs to, |
83 // |object_path| is the object path that the descriptor should have, and | 85 // |object_path| is the object path that the descriptor should have, and |
84 // |delegate| is the object that value Get/Set requests will be passed to and | 86 // |delegate| is the object that value Get/Set requests will be passed to and |
85 // responses generated from. | 87 // responses generated from. |
86 // | 88 // |
87 // Object paths of GATT descriptors must be hierarchical to the path of the | 89 // Object paths of GATT descriptors must be hierarchical to the path of the |
(...skipping 12 matching lines...) Expand all Loading... |
100 protected: | 102 protected: |
101 BluetoothGattDescriptorServiceProvider(); | 103 BluetoothGattDescriptorServiceProvider(); |
102 | 104 |
103 private: | 105 private: |
104 DISALLOW_COPY_AND_ASSIGN(BluetoothGattDescriptorServiceProvider); | 106 DISALLOW_COPY_AND_ASSIGN(BluetoothGattDescriptorServiceProvider); |
105 }; | 107 }; |
106 | 108 |
107 } // namespace bluez | 109 } // namespace bluez |
108 | 110 |
109 #endif // DEVICE_BLUETOOTH_DBUS_BLUETOOTH_GATT_DESCRIPTOR_SERVICE_PROVIDER_H_ | 111 #endif // DEVICE_BLUETOOTH_DBUS_BLUETOOTH_GATT_DESCRIPTOR_SERVICE_PROVIDER_H_ |
OLD | NEW |