Rtos API example

Embed: (wiki syntax)

« Back to documentation index

DiscoveredCharacteristicDescriptor Class Reference

DiscoveredCharacteristicDescriptor Class Reference
[Client]

Representation of a characteristic descriptor discovered. More...

#include <DiscoveredCharacteristicDescriptor.h>

Public Member Functions

 DiscoveredCharacteristicDescriptor (GattClient *client, Gap::Handle_t connectionHandle, GattAttribute::Handle_t attributeHandle, const UUID &uuid)
 Construct a new instance of a DiscoveredCharacteristicDescriptor.
GattClientgetGattClient ()
 Return the GattClient, which can operate on this descriptor.
const GattClientgetGattClient () const
 Return the GattClient, which can operate on this descriptor.
Gap::Handle_t getConnectionHandle () const
 Return the connection handle to the GattServer containing this descriptor.
const UUIDgetUUID (void) const
 Return the UUID of this descriptor.
GattAttribute::Handle_t getAttributeHandle () const
 Return the attribute handle of this descriptor.

Detailed Description

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 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 GattClient::read and GattClient::write.

Definition at line 58 of file DiscoveredCharacteristicDescriptor.h.


Constructor & Destructor Documentation

DiscoveredCharacteristicDescriptor ( GattClient client,
Gap::Handle_t  connectionHandle,
GattAttribute::Handle_t  attributeHandle,
const UUID uuid 
)

Construct a new instance of a DiscoveredCharacteristicDescriptor.

Parameters:
[in]clientThe client that has discovered the descriptor.
[in]connectionHandleHandle of the connection to the GATT server containing the descriptor.
[in]attributeHandleGATT attribute handle of the descriptor.
[in]uuidUUID of the descriptor.
Note:
This constructor is not meant to be called directly by application code. The Gattclient class generates descriptors discovered.

Definition at line 74 of file DiscoveredCharacteristicDescriptor.h.


Member Function Documentation

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.

Returns:
Attribute handle of the descriptor

Definition at line 135 of file DiscoveredCharacteristicDescriptor.h.

Gap::Handle_t getConnectionHandle (  ) const

Return the connection handle to the GattServer containing this descriptor.

Returns:
the connection handle to the GattServer containing this descriptor.

Definition at line 112 of file DiscoveredCharacteristicDescriptor.h.

const GattClient* getGattClient ( void   ) const

Return the GattClient, which can operate on this descriptor.

Returns:
GattClient, which can operate on this descriptor.

Definition at line 100 of file DiscoveredCharacteristicDescriptor.h.

GattClient* getGattClient ( void   )

Return the GattClient, which can operate on this descriptor.

Returns:
GattClient, which can operate on this descriptor.

Definition at line 90 of file DiscoveredCharacteristicDescriptor.h.

const UUID& getUUID ( void   ) const

Return the UUID of this descriptor.

Returns:
UUID of this descriptor.

Definition at line 122 of file DiscoveredCharacteristicDescriptor.h.