summaryrefslogtreecommitdiff
path: root/doc/gatt-api.txt
diff options
context:
space:
mode:
authorLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2019-01-25 16:32:48 +0200
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2019-01-31 14:10:48 +0200
commit0c81f3733eaaa9c18e5b53bf35a7973bf5c9641b (patch)
tree5d292cfb4101c74e48922dc259c46bb8989cec75 /doc/gatt-api.txt
parent61244c0c2f5694a344d76d5feb722e82327cd9cf (diff)
downloadbluez-0c81f3733eaaa9c18e5b53bf35a7973bf5c9641b.tar.gz
doc/gatt-api: Add Handle property
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.
Diffstat (limited to 'doc/gatt-api.txt')
-rw-r--r--doc/gatt-api.txt24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/gatt-api.txt b/doc/gatt-api.txt
index 8dda60b8a..491eb026a 100644
--- a/doc/gatt-api.txt
+++ b/doc/gatt-api.txt
@@ -50,6 +50,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
========================
@@ -257,6 +265,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.
+
Characteristic Descriptors hierarchy
====================================
@@ -332,6 +348,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
=====================