ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

correct the documentation for GattServer::addService

pull/14084/head
Paul Szczeanek 2020-12-23 11:58:11 +00:00 committed by paul.szczepanek@arm.com
parent cdc8845b3c
commit 5e99ea8d7e
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
connectivity/FEATURE_BLE/include/ble/GattServer.h
View File

@ -316,14 +316,18 @@ public:
*
* The process assigns a unique attribute handle to all the elements added
* into the attribute table. This handle is an ID that must be used for
* subsequent interractions with the elements.
* subsequent interactions with the elements.
*
* @note There is no mirror function that removes a single service.
* Application code can remove all the registered services by calling
* reset().
*
* @attention Service, characteristics and descriptors objects registered
* within the GattServer must remain reachable until reset() is called.
* @attention GattServer allocates its own memory for all the attributes.
* The GattServer will set the handles on the service passed in and the
* characteristics it contains. You may record the handles you want to
* interact with in the future. After that the service and characteristics
* you passed in as the parameter may be freed. To write to the GattServer
* instances of the characteristics you have to use the saved handles.
*
* @param[in] service The service to be added; attribute handle of services,
* characteristic and characteristic descriptors are updated by the