diff options
| author | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2017-09-08 12:52:36 +0300 |
|---|---|---|
| committer | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2017-09-22 13:50:17 +0300 |
| commit | ebd800f2f1c81573e55de84a5742a85749758ac5 (patch) | |
| tree | 0c406c6e90400a3e73c6f4b94788631ba332f45f /doc/gatt-api.txt | |
| parent | 99e8efca3f0941a5cfb8e36537f7a6865d4d4b85 (diff) | |
| download | bluez-ebd800f2f1c81573e55de84a5742a85749758ac5.tar.gz | |
doc/gatt-api: Add server support for AcquireWrite and AcquireNotify
This enables servers to use the same mechanism to use packet based IO
using file descriptors bypassing D-Bus.
Note that the application is free to choose any type of medium that can
use file descriptors, thus this is not limited to pipe2 although that is
probably recommended due its simplicity.
Diffstat (limited to 'doc/gatt-api.txt')
| -rw-r--r-- | doc/gatt-api.txt | 36 |
1 files changed, 29 insertions, 7 deletions
diff --git a/doc/gatt-api.txt b/doc/gatt-api.txt index cdd15f301..400470631 100644 --- a/doc/gatt-api.txt +++ b/doc/gatt-api.txt @@ -91,13 +91,16 @@ Methods array{byte} ReadValue(dict options) org.bluez.Error.NotAuthorized org.bluez.Error.NotSupported - fd, uint16 AcquireWrite() [experimental] (Client only) + fd, uint16 AcquireWrite(dict options) [experimental, optional] Acquire file descriptor and MTU for writing. Usage of WriteValue will be locked causing it to return NotPermitted error. - Only works with characteristic that has + For server the MTU returned shall be equal or smaller + than the negotiated MTU. + + For client it only works with characteristic that has WriteAcquired property which relies on write-without-response Flag. @@ -111,15 +114,21 @@ Methods array{byte} ReadValue(dict options) that the file descriptor is closed during reconnections as the MTU has to be renegotiated. + Possible options: "device": Object Device (Server only) + "MTU": Exchanged MTU (Server only) + Possible Errors: org.bluez.Error.Failed org.bluez.Error.NotSupported - fd, uint16 AcquireNotify() [experimental] (Client only) + fd, uint16 AcquireNotify(dict options) [experimental, optional] Acquire file descriptor and MTU for notify. Usage of StartNotify will be locked causing it to return NotPermitted error. + For server the MTU returned shall be equal or smaller + than the negotiated MTU. + Only works with characteristic that has NotifyAcquired which relies on notify Flag and no other client have called StartNotify. @@ -140,6 +149,9 @@ Methods array{byte} ReadValue(dict options) that the file descriptor is closed during reconnections as the MTU has to be renegotiated. + Possible options: "device": Object Device (Server only) + "MTU": Exchanged MTU (Server only) + Possible Errors: org.bluez.Error.Failed org.bluez.Error.NotSupported @@ -188,14 +200,24 @@ Properties string UUID [read-only] boolean WriteAcquired [read-only, optional] True, if this characteristic has been acquired by any - client using AcquireWrite. This properties is ommited - in case 'write-without-response' flag is not set. + client using AcquireWrite. + + For client properties is ommited in case + 'write-without-response' flag is not set. + + For server the presence of this property indicates + that AcquireWrite is supported. boolean NotifyAcquired [read-only, optional] True, if this characteristic has been acquired by any - client using AcquireNotify. This properties is ommited - in case 'notify' flag is not set. + client using AcquireNotify. + + For client this properties is ommited in case 'notify' + flag is not set. + + For server the presence of this property indicates + that AcquireNotify is supported. boolean Notifying [read-only, optional] |