summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDagan Martinez <dmartinez@starry.com>2021-10-01 10:17:19 -0400
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2021-10-01 10:58:56 -0700
commit7d0fc7e7f0e4585a97c6a214872106507d1199b9 (patch)
tree145f7c8d8fde38ad662c17453da1332a60b765b5 /doc
parentc1e6d6c46fcab55ec820bb83396fff57ffd22e26 (diff)
downloadbluez-7d0fc7e7f0e4585a97c6a214872106507d1199b9.tar.gz
doc/gatt-api: Add 'X-notify`/`X-indicate`
Update docs to reflect the addition of the `X-notify` and `X-indicate` characteristic flags, which allow a GATT server to restrict CCC write permissions.
Diffstat (limited to 'doc')
-rw-r--r--doc/gatt-api.txt15
1 files changed, 14 insertions, 1 deletions
diff --git a/doc/gatt-api.txt b/doc/gatt-api.txt
index 120b23d1a..af0aa761d 100644
--- a/doc/gatt-api.txt
+++ b/doc/gatt-api.txt
@@ -253,7 +253,14 @@ Properties string UUID [read-only]
Defines how the characteristic value can be used. See
Core spec "Table 3.5: Characteristic Properties bit
field", and "Table 3.8: Characteristic Extended
- Properties bit field". Allowed values:
+ Properties bit field".
+
+ The "x-notify" and "x-indicate" flags restrict access
+ to notifications and indications by imposing write
+ restrictions on a characteristic's client
+ characteristic configuration descriptor.
+
+ Allowed values:
"broadcast"
"read"
@@ -267,10 +274,16 @@ Properties string UUID [read-only]
"writable-auxiliaries"
"encrypt-read"
"encrypt-write"
+ "encrypt-notify" (Server only)
+ "encrypt-indicate" (Server only)
"encrypt-authenticated-read"
"encrypt-authenticated-write"
+ "encrypt-authenticated-notify" (Server only)
+ "encrypt-authenticated-indicate" (Server only)
"secure-read" (Server only)
"secure-write" (Server only)
+ "secure-notify" (Server only)
+ "secure-indicate" (Server only)
"authorize"
uint16 Handle [read-write, optional] (Server Only)