Mbed OS Reference
Loading...
Searching...
No Matches
CharacteristicDescriptorDiscovery Class Reference

Definitions of events and event handlers that the characteristic descriptor discovery procedure uses. More...

#include <CharacteristicDescriptorDiscovery.h>

Data Structures

struct  DiscoveryCallbackParams_t
 Characteristic descriptor discovered event. More...
 
struct  TerminationCallbackParams_t
 Characteristic descriptor discovery ended event. More...
 

Public Types

typedef FunctionPointerWithContext< const DiscoveryCallbackParams_t * > DiscoveryCallback_t
 Characteristic descriptor discovered event handler. More...
 
typedef FunctionPointerWithContext< const TerminationCallbackParams_t * > TerminationCallback_t
 Handler of Characteristic descriptor discovery ended event. More...
 

Detailed Description

Definitions of events and event handlers that the characteristic descriptor discovery procedure uses.

This class acts like a namespace for characteristic descriptor discovery types. Like ServiceDiscovery, it provides callbacks and callbacks parameters types related to the characteristic descriptor discovery process, but contrary to the ServiceDiscovery class, it does not force the porter to use a specific interface for the characteristic descriptor discovery process.

Definition at line 44 of file gatt/CharacteristicDescriptorDiscovery.h.

Member Typedef Documentation

◆ DiscoveryCallback_t

Characteristic descriptor discovered event handler.

As a parameter, it expects a pointer to a DiscoveryCallbackParams_t instance.

Note
The object passed in parameter will remain valid for the lifetime of the callback. The BLE_API eventing framework owns memory for this object. The application can safely make a persistent shallow-copy of this object to work with the service beyond the callback.
See also
DiscoveryCallbackParams_t GattClient::discoverCharacteristicDescriptors DiscoveredCharacteristic::discoverDescriptors

Definition at line 117 of file gatt/CharacteristicDescriptorDiscovery.h.

◆ TerminationCallback_t

Handler of Characteristic descriptor discovery ended event.

As a parameter, it expects a pointer to a TerminationCallbackParams_t instance.

Note
The object passed in parameter will remain valid for the lifetime of the callback. The BLE_API eventing framework owns the memory for this object. The application can safely make a persistent shallow-copy of this object to work with the service beyond the callback.
See also
TerminationCallbackParams_t GattClient::discoverCharacteristicDescriptors DiscoveredCharacteristic::discoverDescriptors

Definition at line 134 of file gatt/CharacteristicDescriptorDiscovery.h.