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
|
// Copyright 2016 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef DEVICE_BLUETOOTH_BLUETOOTH_REMOTE_GATT_DESCRIPTOR_H_
#define DEVICE_BLUETOOTH_BLUETOOTH_REMOTE_GATT_DESCRIPTOR_H_
#include <stdint.h>
#include <optional>
#include <vector>
#include "base/functional/callback.h"
#include "base/functional/callback_forward.h"
#include "device/bluetooth/bluetooth_export.h"
#include "device/bluetooth/bluetooth_gatt_descriptor.h"
#include "device/bluetooth/public/cpp/bluetooth_uuid.h"
namespace device {
class BluetoothRemoteGattCharacteristic;
// BluetoothRemoteGattDescriptor represents a remote GATT characteristic
// descriptor.
//
// Note: We use virtual inheritance on the GATT descriptor since it will be
// inherited by platform specific versions of the GATT descriptor classes also.
// The platform specific remote GATT descriptor classes will inherit both this
// class and their GATT descriptor class, hence causing an inheritance diamond.
class DEVICE_BLUETOOTH_EXPORT BluetoothRemoteGattDescriptor
: public virtual BluetoothGattDescriptor {
public:
BluetoothRemoteGattDescriptor(const BluetoothRemoteGattDescriptor&) = delete;
BluetoothRemoteGattDescriptor& operator=(
const BluetoothRemoteGattDescriptor&) = delete;
~BluetoothRemoteGattDescriptor() override;
// The ValueCallback is used to return the value of a remote characteristic
// descriptor upon a read request.
//
// This callback is called on both success and failure. On error |error_code|
// will contain a value and |value| should be ignored. When successful
// |error_code| will have no value and |value| may be used.
using ValueCallback = base::OnceCallback<void(
std::optional<BluetoothGattService::GattErrorCode> error_code,
const std::vector<uint8_t>& value)>;
// Returns the value of the descriptor. For remote descriptors, this is the
// most recently cached value of the remote descriptor. For local descriptors
// this is the most recently updated value or the value retrieved from the
// delegate.
virtual const std::vector<uint8_t>& GetValue() const = 0;
// Returns a pointer to the GATT characteristic that this characteristic
// descriptor belongs to.
virtual BluetoothRemoteGattCharacteristic* GetCharacteristic() const = 0;
// Sends a read request to a remote characteristic descriptor to read its
// value. |callback| is called to return the read value on success or error.
virtual void ReadRemoteDescriptor(ValueCallback callback) = 0;
// Sends a write request to a remote characteristic descriptor, to modify the
// value of the descriptor with the new value |new_value|. |callback| is
// called to signal success and |error_callback| for failures. This method
// only applies to remote descriptors and will fail for those that are locally
// hosted.
virtual void WriteRemoteDescriptor(base::span<const uint8_t> new_value,
base::OnceClosure callback,
ErrorCallback error_callback) = 0;
protected:
BluetoothRemoteGattDescriptor();
};
} // namespace device
#endif // DEVICE_BLUETOOTH_BLUETOOTH_REMOTE_GATT_DESCRIPTOR_H_
|
