Representation of a characteristic descriptor discovered. More...
#include <DiscoveredCharacteristicDescriptor.h>
Public Member Functions | |
| DiscoveredCharacteristicDescriptor (ble::GattClient *client, ble::connection_handle_t connectionHandle, GattAttribute::Handle_t attributeHandle, const UUID &uuid) | |
| Construct a new instance of a DiscoveredCharacteristicDescriptor. More... | |
| ble::GattClient * | getGattClient () |
| Return the ble::GattClient, which can operate on this descriptor. More... | |
| const ble::GattClient * | getGattClient () const |
| Return the ble::GattClient, which can operate on this descriptor. More... | |
| ble::connection_handle_t | getConnectionHandle () const |
| Return the connection handle to the GattServer containing this descriptor. More... | |
| const UUID & | getUUID () const |
| Return the UUID of this descriptor. More... | |
| GattAttribute::Handle_t | getAttributeHandle () const |
| Return the attribute handle of this descriptor. More... | |
Representation of a characteristic descriptor discovered.
Characteristic descriptors can be seen as the metadata of the characteristic. They can contain things such as the unit of the characteristic value, extra permission informations or the Client Configuration state in regard to notification or indication.
The descriptors of a characterstic are discovered by a Characteristic Descriptor Discovery Procedure, which can be initiated by either ble::GattClient::discoverCharacteristicDescriptors() or DiscoveredCharacteristic::discoverDescriptors().
The discovery procedure returns the UUID of the descriptor (its type) and its handle.
Read and write of the descriptor value can be initiated by ble::GattClient::read and ble::GattClient::write.
Definition at line 63 of file gatt/DiscoveredCharacteristicDescriptor.h.
| DiscoveredCharacteristicDescriptor | ( | ble::GattClient * | client, |
| ble::connection_handle_t | connectionHandle, | ||
| GattAttribute::Handle_t | attributeHandle, | ||
| const UUID & | uuid | ||
| ) |
Construct a new instance of a DiscoveredCharacteristicDescriptor.
| [in] | client | The client that has discovered the descriptor. |
| [in] | connectionHandle | Handle of the connection to the GATT server containing the descriptor. |
| [in] | attributeHandle | GATT attribute handle of the descriptor. |
| [in] | uuid | UUID of the descriptor. |
Definition at line 79 of file gatt/DiscoveredCharacteristicDescriptor.h.
| GattAttribute::Handle_t getAttributeHandle | ( | ) | const |
Return the attribute handle of this descriptor.
This attribute handle can be used to interact with the descriptor on its gatt server.
Definition at line 140 of file gatt/DiscoveredCharacteristicDescriptor.h.
| ble::connection_handle_t getConnectionHandle | ( | ) | const |
Return the connection handle to the GattServer containing this descriptor.
Definition at line 117 of file gatt/DiscoveredCharacteristicDescriptor.h.
| ble::GattClient* getGattClient | ( | ) |
Return the ble::GattClient, which can operate on this descriptor.
Definition at line 95 of file gatt/DiscoveredCharacteristicDescriptor.h.
| const ble::GattClient* getGattClient | ( | ) | const |
Return the ble::GattClient, which can operate on this descriptor.
Definition at line 105 of file gatt/DiscoveredCharacteristicDescriptor.h.
| const UUID& getUUID | ( | ) | const |
Return the UUID of this descriptor.
Definition at line 127 of file gatt/DiscoveredCharacteristicDescriptor.h.
