doc/gatt-api: Add Handle property
authorLuiz Augusto von Dentz <luiz.von.dentz@intel.com>
Fri, 25 Jan 2019 14:32:48 +0000 (16:32 +0200)
committerhimanshu <h.himanshu@samsung.com>
Wed, 22 Jan 2020 13:31:22 +0000 (19:01 +0530)
When acting as server it is useful to select where to allocate the
handle for an attribute so it can be restored in the same position when
restarting the daemon or rebooting the system.

In order to do that the application also needs to know in which handle
the attribute is allocated the very first time it is registered, this
also allows for a better integration with PTS and tools like auto-pts
which needs to know the handles where the attributes have been
allocated.

Change-Id: I298c07b8e6e6cb1bc163412b5c7acaed9a64b004
Signed-off-by: himanshu <h.himanshu@samsung.com>
doc/gatt-api.txt

index bd7d325..855ec6a 100755 (executable)
@@ -60,6 +60,14 @@ Properties   string UUID [read-only]
                        Array of object paths representing the included
                        services of this service.
 
+               uint16 Handle [read-write, optional] (Server Only)
+
+                       Service handle. When available in the server it
+                       would attempt to use to allocate into the database
+                       which may fail, to auto allocate the value 0x0000
+                       shall be used which will cause the allocated handle to
+                       be set once registered.
+
 
 Characteristic hierarchy
 ========================
@@ -267,6 +275,15 @@ Properties string UUID [read-only]
                                "secure-write" (Server only)
                                "authorize"
 
+               uint16 Handle [read-write, optional] (Server Only)
+
+                       Characteristic handle. When available in the server it
+                       would attempt to use to allocate into the database
+                       which may fail, to auto allocate the value 0x0000
+                       shall be used which will cause the allocated handle to
+                       be set once registered.
+
+
 #ifdef TIZEN_FEATURE_BLUEZ_MODIFY
                array{object} Descriptors [read-only]
 
@@ -358,6 +375,14 @@ Properties string UUID [read-only]
                                "secure-write" (Server Only)
                                "authorize"
 
+               uint16 Handle [read-write, optional] (Server Only)
+
+                       Characteristic handle. When available in the server it
+                       would attempt to use to allocate into the database
+                       which may fail, to auto allocate the value 0x0000
+                       shall be used which will cause the allocated handle to
+                       be set once registered.
+
 GATT Profile hierarchy
 =====================