michaelh/zephyr
1
0
Fork 0
Code Releases Activity

Bluetooth: GATT: Document settings_load and service register requirement

Browse source 
Document that all services that should be included in the initial
database hash should be registered before calling settings load. All
services added after settings_load will trigger a new hash calculation
and a new value stored. This would result in the database hash always
being rewritten.

Signed-off-by: Joakim Andersson <joakim.andersson@nordicsemi.no>
This commit is contained in:
Joakim Andersson 2020-02-12 12:49:34 +01:00 • committed by Johan Hedberg
commit ee3f634cf7
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
include/bluetooth/gatt.h
View file

@ -310,6 +310,12 @@ struct bt_gatt_cpf {
* macros such as BT_GATT_PRIMARY_SERVICE, BT_GATT_CHARACTERISTIC,
* BT_GATT_DESCRIPTOR, etc.
*
* When using :option:`CONFIG_BT_GATT_CACHING` and :option:`CONFIG_BT_SETTINGS`
* then all services that should be included in the GATT Database Hash
* calculation should be added before calling @ref settings_load.
* All services registered after settings_load will trigger a new database hash
* calculation and a new hash stored.
*
* @param svc Service containing the available attributes
*
* @return 0 in case of success or negative value in case of error.