michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Bluetooth: GATT: Add documentation for empty notifications in callback

Browse source 
Adds documentation specifically for empty notification in the
bt_gatt_notify_func_t callback, as that works a bit different
from e.g. reading an empty characteristic.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
This commit is contained in:
Emil Gydesen 2021-04-22 09:05:46 +02:00 • committed by Carles Cufí
commit a4108e7b0b
1 changed files with 4 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
include/bluetooth/gatt.h
View file

@ -1454,6 +1454,10 @@ struct bt_gatt_subscribe_params;
/** @typedef bt_gatt_notify_func_t /** @typedef bt_gatt_notify_func_t
* @brief Notification callback function * @brief Notification callback function
* *
* In the case of an empty notification, the @p data pointer will be non-NULL
* while the @p length will be 0, which is due to the special case where
* a @p data NULL pointer means unsubscribed.
*
* @param conn Connection object. May be NULL, indicating that the peer is * @param conn Connection object. May be NULL, indicating that the peer is
* being unpaired * being unpaired
* @param params Subscription parameters. * @param params Subscription parameters.