change BLECLientCharacteristic notify callback signature

hathach · hathach · commit d0655b369d18 · 2018-01-18T15:07:39.000+07:00
from
notify_cb(BLEClientCharacteristic&amp; chr, uint8_t* data, uint16_t len)
to
notify_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len)

Added
diff --git a/changelog.md b/changelog.md
@@ -5,7 +5,11 @@
 - Fixed burning bootloader issue with MacOS
 - Added gpstest_swuart example sketch
 - Added indicate API for BLECharacteristic
-- Added useAdaCallback option to setNotifyCallback(), setIndicateCallback() for BLEClientCharacteristic
+- BLEClientCharacteristic
+  - Added setIndicateCallback(), issue #113
+  - Added useAdaCallback option to setNotifyCallback(), setIndicateCallback()
+  - Change notify callback signature from 
+notify_cb(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len) to notify_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len)
 
 ## 0.8.1
 
diff --git a/libraries/Bluefruit52Lib/examples/Central/central_custom_hrm/central_custom_hrm.ino b/libraries/Bluefruit52Lib/examples/Central/central_custom_hrm/central_custom_hrm.ino
@@ -175,12 +175,12 @@ void disconnect_callback(uint16_t conn_handle, uint8_t reason)
 
 /**
  * Hooked callback that triggered when a measurement value is sent from peripheral
- * @param chr   Reference to client characteristic that even occurred,
+ * @param chr   Pointer client characteristic that even occurred,
  *              in this example it should be hrmc
  * @param data  Pointer to received data
  * @param len   Length of received data
  */
-void hrm_notify_callback(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len)
+void hrm_notify_callback(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len)
 {
   // https://www.bluetooth.com/specifications/gatt/viewer?attributeXmlFile=org.bluetooth.characteristic.heart_rate_measurement.xml
   // Measurement contains of control byte0 and measurement (8 or 16 bit) + optional field
diff --git a/libraries/Bluefruit52Lib/src/BLEClientCharacteristic.cpp b/libraries/Bluefruit52Lib/src/BLEClientCharacteristic.cpp
@@ -408,10 +408,11 @@ void BLEClientCharacteristic::_eventHandler(ble_evt_t* evt)
               if (!data) return;
               memcpy(data, hvx->data, hvx->len);
 
+              // data is free by callback
               ada_callback(data, _notify_cb, this, data, hvx->len);
             }else
             {
-              _notify_cb(*this, hvx->data, hvx->len);
+              _notify_cb(this, hvx->data, hvx->len);
             }
           }
         break;
@@ -426,10 +427,11 @@ void BLEClientCharacteristic::_eventHandler(ble_evt_t* evt)
               if (!data) return;
               memcpy(data, hvx->data, hvx->len);
 
-              ada_callback(data, _notify_cb, this, data, hvx->len);
+              // data is free by callback
+              ada_callback(data, _indicate_cb, this, data, hvx->len);
             }else
             {
-              _notify_cb(*this, hvx->data, hvx->len);
+              _indicate_cb(this, hvx->data, hvx->len);
             }
           }
         break;
diff --git a/libraries/Bluefruit52Lib/src/BLEClientCharacteristic.h b/libraries/Bluefruit52Lib/src/BLEClientCharacteristic.h
@@ -47,8 +47,8 @@ class BLEClientCharacteristic
 {
   public:
     /*--------- Callback Signatures ----------*/
-    typedef void (*notify_cb_t  ) (BLEClientCharacteristic& chr, uint8_t* data, uint16_t len);
-    typedef void (*indicate_cb_t) (BLEClientCharacteristic& chr, uint8_t* data, uint16_t len);
+    typedef void (*notify_cb_t  ) (BLEClientCharacteristic* chr, uint8_t* data, uint16_t len);
+    typedef void (*indicate_cb_t) (BLEClientCharacteristic* chr, uint8_t* data, uint16_t len);
 
     BLEUuid uuid;
 
diff --git a/libraries/Bluefruit52Lib/src/clients/BLEAncs.cpp b/libraries/Bluefruit52Lib/src/clients/BLEAncs.cpp
@@ -40,8 +40,8 @@
 
 #define DEBUG_ANCS    0
 
-void bleancs_notification_cb(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len);
-void bleancs_data_cb(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len);
+void bleancs_notification_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len);
+void bleancs_data_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len);
 
 /* ANCS Service        : 7905F431-B5CE-4E99-A40F-4B1E122D00D0
  * Control Point       : 69D1D8F3-45E1-49A8-9821-9BBDFDAAD9D9
@@ -383,14 +383,14 @@ bool BLEAncs::actNegative(uint32_t uid)
 /*------------------------------------------------------------------*/
 /* Callback
  *------------------------------------------------------------------*/
-void bleancs_notification_cb(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len)
+void bleancs_notification_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len)
 {
-  BLEAncs& svc = (BLEAncs&) chr.parentService();
+  BLEAncs& svc = (BLEAncs&) chr->parentService();
   svc._handleNotification(data, len);
 }
 
-void bleancs_data_cb(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len)
+void bleancs_data_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len)
 {
-  BLEAncs& svc = (BLEAncs&) chr.parentService();
+  BLEAncs& svc = (BLEAncs&) chr->parentService();
   svc._handleData(data, len);
 }
diff --git a/libraries/Bluefruit52Lib/src/clients/BLEAncs.h b/libraries/Bluefruit52Lib/src/clients/BLEAncs.h
@@ -177,8 +177,8 @@ class BLEAncs : public BLEClientService
     void _handleNotification(uint8_t* data, uint16_t len);
     void _handleData(uint8_t* data, uint16_t len);
 
-    friend void bleancs_notification_cb(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len);
-    friend void bleancs_data_cb        (BLEClientCharacteristic& chr, uint8_t* data, uint16_t len);
+    friend void bleancs_notification_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len);
+    friend void bleancs_data_cb        (BLEClientCharacteristic* chr, uint8_t* data, uint16_t len);
 };
 
 
diff --git a/libraries/Bluefruit52Lib/src/clients/BLEClientCts.cpp b/libraries/Bluefruit52Lib/src/clients/BLEClientCts.cpp
@@ -36,7 +36,7 @@
 
 #include "bluefruit.h"
 
-void blects_central_notify_cb(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len);
+void blects_central_notify_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len);
 
 BLEClientCts::BLEClientCts(void)
  : BLEClientService(UUID16_SVC_CURRENT_TIME), _cur_time(UUID16_CHR_CURRENT_TIME), _local_info(UUID16_CHR_LOCAL_TIME_INFORMATION)
@@ -107,7 +107,7 @@ void BLEClientCts::_cur_time_notify_cb(uint8_t* data, uint16_t len)
   if ( _adjust_cb ) _adjust_cb( Time.adjust_reason );
 }
 
-void blects_central_notify_cb(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len)
+void blects_central_notify_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len)
 {
-  ((BLEClientCts&) chr.parentService())._cur_time_notify_cb(data, len);
+  ((BLEClientCts&) chr->parentService())._cur_time_notify_cb(data, len);
 }
diff --git a/libraries/Bluefruit52Lib/src/clients/BLEClientUart.cpp b/libraries/Bluefruit52Lib/src/clients/BLEClientUart.cpp
@@ -36,7 +36,7 @@
 
 #include "bluefruit.h"
 
-void bleuart_central_notify_cb(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len);
+void bleuart_central_notify_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len);
 
 BLEClientUart::BLEClientUart(uint16_t fifo_depth)
   : BLEClientService(BLEUART_UUID_SERVICE), _txd(BLEUART_UUID_CHR_TXD), _rxd(BLEUART_UUID_CHR_RXD),
@@ -96,9 +96,9 @@ void BLEClientUart::disconnect(void)
   flush();
 }
 
-void bleuart_central_notify_cb(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len)
+void bleuart_central_notify_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len)
 {
-  BLEClientUart& uart_svc = (BLEClientUart&) chr.parentService();
+  BLEClientUart& uart_svc = (BLEClientUart&) chr->parentService();
   uart_svc._rx_fifo.write(data, len);
 
   // invoke callback
diff --git a/libraries/Bluefruit52Lib/src/clients/BLEClientUart.h b/libraries/Bluefruit52Lib/src/clients/BLEClientUart.h
@@ -83,7 +83,7 @@ class BLEClientUart : public BLEClientService, public Stream
     Adafruit_FIFO     _rx_fifo;
     rx_callback_t     _rx_cb;
 
-    friend void bleuart_central_notify_cb(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len);
+    friend void bleuart_central_notify_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len);
 };
 
 #endif /* BLECLIENTUART_H_ */

Original file line number	Diff line number	Diff line change
`@@ -408,10 +408,11 @@ void BLEClientCharacteristic::_eventHandler(ble_evt_t* evt)`
`408`	`408`	`if (!data) return;`
`409`	`409`	`memcpy(data, hvx->data, hvx->len);`
`410`	`410`
	`411`	`+ // data is free by callback`
`411`	`412`	`ada_callback(data, _notify_cb, this, data, hvx->len);`
`412`	`413`	`}else`
`413`	`414`	`{`
`414`		`- _notify_cb(*this, hvx->data, hvx->len);`
	`415`	`+ _notify_cb(this, hvx->data, hvx->len);`
`415`	`416`	`}`
`416`	`417`	`}`
`417`	`418`	`break;`
`@@ -426,10 +427,11 @@ void BLEClientCharacteristic::_eventHandler(ble_evt_t* evt)`
`426`	`427`	`if (!data) return;`
`427`	`428`	`memcpy(data, hvx->data, hvx->len);`
`428`	`429`
`429`		`- ada_callback(data, _notify_cb, this, data, hvx->len);`
	`430`	`+ // data is free by callback`
	`431`	`+ ada_callback(data, _indicate_cb, this, data, hvx->len);`
`430`	`432`	`}else`
`431`	`433`	`{`
`432`		`- _notify_cb(*this, hvx->data, hvx->len);`
	`434`	`+ _indicate_cb(this, hvx->data, hvx->len);`
`433`	`435`	`}`
`434`	`436`	`}`
`435`	`437`	`break;`
Original file line number	Diff line number	Diff line change
`@@ -47,8 +47,8 @@ class BLEClientCharacteristic`
`47`	`47`	`{`
`48`	`48`	`public:`
`49`	`49`	`/--------- Callback Signatures ----------/`
`50`		`- typedef void (notify_cb_t ) (BLEClientCharacteristic& chr, uint8_t data, uint16_t len);`
`51`		`- typedef void (indicate_cb_t) (BLEClientCharacteristic& chr, uint8_t data, uint16_t len);`
	`50`	`+ typedef void (notify_cb_t ) (BLEClientCharacteristic chr, uint8_t* data, uint16_t len);`
	`51`	`+ typedef void (indicate_cb_t) (BLEClientCharacteristic chr, uint8_t* data, uint16_t len);`
`52`	`52`
`53`	`53`	`BLEUuid uuid;`
`54`	`54`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@`
`36`	`36`
`37`	`37`	`#include "bluefruit.h"`
`38`	`38`
`39`		`-void blects_central_notify_cb(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len);`
	`39`	`+void blects_central_notify_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len);`
`40`	`40`
`41`	`41`	`BLEClientCts::BLEClientCts(void)`
`42`	`42`	`: BLEClientService(UUID16_SVC_CURRENT_TIME), _cur_time(UUID16_CHR_CURRENT_TIME), _local_info(UUID16_CHR_LOCAL_TIME_INFORMATION)`
`@@ -107,7 +107,7 @@ void BLEClientCts::_cur_time_notify_cb(uint8_t* data, uint16_t len)`
`107`	`107`	`if ( _adjust_cb ) _adjust_cb( Time.adjust_reason );`
`108`	`108`	`}`
`109`	`109`
`110`		`-void blects_central_notify_cb(BLEClientCharacteristic& chr, uint8_t* data, uint16_t len)`
	`110`	`+void blects_central_notify_cb(BLEClientCharacteristic* chr, uint8_t* data, uint16_t len)`
`111`	`111`	`{`
`112`		`- ((BLEClientCts&) chr.parentService())._cur_time_notify_cb(data, len);`
	`112`	`+ ((BLEClientCts&) chr->parentService())._cur_time_notify_cb(data, len);`
`113`	`113`	`}`