Jacob McEntire / BLE_API_mod2

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of BLE_API by Bluetooth Low Energy

Diff: public/BLEDevice.h

Revision:
297:7036ac0bd496
Parent:
296:931da9973b89
Child:
299:c1e4400af825
--- a/public/BLEDevice.h	Mon Mar 02 11:50:47 2015 +0000
+++ b/public/BLEDevice.h	Mon Mar 02 11:50:47 2015 +0000
@@ -253,6 +253,10 @@
     /**
      * Setup a callback for when a characteristic is being read by a client.
      *
+     * @Note: this functionality may not be available on all underlying stacks.
+     * You could use GattCharacteristic::setReadAuthorizationCallback() as an
+     * alternative.
+     *
      * @Note: it is possible to chain together multiple onDataRead callbacks
      * (potentially from different modules of an application) to receive updates
      * to characteristics. Services may add their own onDataRead callbacks
@@ -260,6 +264,9 @@
      *
      * @Note: it is also possible to setup a callback into a member function of
      * some object.
+     *
+     * @return BLE_ERROR_NOT_IMPLEMENTED if this functionality isn't available;
+     *         else BLE_ERROR_NONE.
      */
     ble_error_t onDataRead(void (*callback)(const GattCharacteristicReadCBParams *eventDataP));
     template <typename T> ble_error_t onDataRead(T * objPtr, void (T::*memberPtr)(const GattCharacteristicReadCBParams *context));