adaptation for book and plug demo

Dependents:   BookAndPlug

Fork of BLE_API by Bluetooth Low Energy

Embed: (wiki syntax)

« Back to documentation index

DiscoveredCharacteristicDescriptor Class Reference

DiscoveredCharacteristicDescriptor Class Reference

Representation of a descriptor discovered during a GattClient discovery procedure (see GattClient::discoverCharacteristicDescriptors or DiscoveredCharacteristic::discoverDescriptors ). 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
GattClient * getGattClient ()
 Return the GattClient which can operate on this descriptor.
const GattClient * getGattClient () const
 Return the GattClient which can operate on this descriptor.
Gap::Handle_t getConnectionHandle () const
 Return the connection handle to the GattServer which contain this descriptor.
const UUIDgetUUID (void) const
 Return the UUID of this descriptor.
GattAttribute::Handle_t getAttributeHandle () const
 Return the attribute handle to use to access to this descriptor on the gatt server.

Detailed Description

Representation of a descriptor discovered during a GattClient discovery procedure (see GattClient::discoverCharacteristicDescriptors or DiscoveredCharacteristic::discoverDescriptors ).

Provide detailed informations about a discovered characteristic descriptor like:

  • Its UUID (see getUUID).
  • Its handle (see getAttributeHandle) Basic read (see GattClient::read) and write (see GattClient::write) procedure from GattClient can be used access the value of the descriptor.

Definition at line 42 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:
clientThe client from where the descriptor has been discovered
connectionHandleThe connection handle on which the descriptor has been discovered
attributeHandleThe handle of the attribute containing this descriptor
uuidThe UUID of the descriptor

Definition at line 55 of file DiscoveredCharacteristicDescriptor.h.


Member Function Documentation

GattAttribute::Handle_t getAttributeHandle (  ) const

Return the attribute handle to use to access to this descriptor on the gatt server.

Returns:
The attribute handle of the descriptor

Definition at line 100 of file DiscoveredCharacteristicDescriptor.h.

Gap::Handle_t getConnectionHandle (  ) const

Return the connection handle to the GattServer which contain this descriptor.

Returns:
the connection handle to the GattServer which contain this descriptor.

Definition at line 83 of file DiscoveredCharacteristicDescriptor.h.

const GattClient* getGattClient (  ) const

Return the GattClient which can operate on this descriptor.

Returns:
The GattClient which can operate on this descriptor.

Definition at line 73 of file DiscoveredCharacteristicDescriptor.h.

GattClient* getGattClient (  )

Return the GattClient which can operate on this descriptor.

Returns:
The GattClient which can operate on this descriptor.

Definition at line 65 of file DiscoveredCharacteristicDescriptor.h.

const UUID& getUUID ( void   ) const

Return the UUID of this descriptor.

Returns:
the UUID of this descriptor

Definition at line 91 of file DiscoveredCharacteristicDescriptor.h.