michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Bluetooth: GATT: Add note about parameters of async procedures

Browse source 
Asynchronous functions use the parameters to store relevant data even
after the scope it has been called which means they have to remain valid
while the operations are in course.

Change-Id: I2cc79e5ce352fef4e077e9fb4cb0f4d111463d00
Signed-off-by: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>
This commit is contained in:
Luiz Augusto von Dentz 2015-12-17 12:46:22 -02:00 • committed by Anas Nashif
commit a855c68943
1 changed files with 21 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

9
include/bluetooth/gatt.h
View file

@ -722,6 +722,9 @@ struct bt_gatt_discover_params {
* For each attribute found the callback is called which can then decide
* whether to continue discovering or stop.
*
* Note: This procedure is asynchronous therefore the parameters need to
* remains valid while it is active.
*
* @param conn Connection object.
* @param params Discover parameters.
*
@ -756,6 +759,9 @@ struct bt_gatt_read_params {
*
* This procedure read the attribute value and return it to the callback.
*
* Note: This procedure is asynchronous therefore the parameters need to
* remains valid while it is active.
*
* @param conn Connection object.
* @param params Read parameters.
*
@ -821,6 +827,9 @@ struct bt_gatt_subscribe_params {
* notified value. One may then decide whether to unsubscribe directly from
* this callback.
*
* Note: This procedure is asynchronous therefore the parameters need to
* remains valid while it is active.
*
* @param conn Connection object.
* @param params Subscribe parameters.
*