doc/gatt-api: Add 'X-notify`/`X-indicate`
authorDagan Martinez <dmartinez@starry.com>
Fri, 1 Oct 2021 14:17:19 +0000 (10:17 -0400)
committerAyush Garg <ayush.garg@samsung.com>
Fri, 11 Mar 2022 13:38:37 +0000 (19:08 +0530)
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.

Signed-off-by: Anuj Jain <anuj01.jain@samsung.com>
Signed-off-by: Ayush Garg <ayush.garg@samsung.com>
doc/gatt-api.txt

index dcd47df3df149190b39c7f38ead54ee8f0b244b0..149203d804a5c3d158debd489a1920a085a1cee9 100755 (executable)
@@ -263,7 +263,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"
@@ -277,10 +284,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)