Bluetooth: GATT: Document notify callback return parameters

Document the possible return values of the notify callback and the
action it takes.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
This commit is contained in:
Joakim Andersson 2020-01-08 12:13:40 +01:00 committed by Johan Hedberg
commit 900b4b0679

View file

@ -1261,6 +1261,9 @@ struct bt_gatt_subscribe_params;
* @param params Subscription parameters. * @param params Subscription parameters.
* @param data Attribute value data. If NULL then subscription was removed. * @param data Attribute value data. If NULL then subscription was removed.
* @param length Attribute value length. * @param length Attribute value length.
*
* @return BT_GATT_ITER_CONTINUE to continue receiving value notifications.
* BT_GATT_ITER_STOP to unsubscribe from value notifications.
*/ */
typedef u8_t (*bt_gatt_notify_func_t)(struct bt_conn *conn, typedef u8_t (*bt_gatt_notify_func_t)(struct bt_conn *conn,
struct bt_gatt_subscribe_params *params, struct bt_gatt_subscribe_params *params,