diff options
| author | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2017-07-03 14:06:06 +0300 |
|---|---|---|
| committer | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2017-07-05 14:27:40 +0300 |
| commit | c89618370dce83aa561ef733179a0b62ad927e93 (patch) | |
| tree | ba1834ec047a89e94b11495e001715bedb495acb /doc/gatt-api.txt | |
| parent | 706f9cb68fedb05b963c32d26c264c31d2f551f6 (diff) | |
| download | bluez-c89618370dce83aa561ef733179a0b62ad927e93.tar.gz | |
client: Add release-notify command
This adds release-notify command which closes an existing fd unlocking
the attribute:
[Test peripheral:/service001f/char0020]# release-notify
[CHG] Attribute /org/bluez/hci1/dev_69_16_5B_9A_06_CD/service001f/char0020 NotifyAcquired: no
Diffstat (limited to 'doc/gatt-api.txt')
| -rw-r--r-- | doc/gatt-api.txt | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/doc/gatt-api.txt b/doc/gatt-api.txt index 3f4a3ca3f..c0ad1de25 100644 --- a/doc/gatt-api.txt +++ b/doc/gatt-api.txt @@ -93,8 +93,9 @@ Methods array{byte} ReadValue(dict options) fd, uint16 AcquireWrite() [experimental] (Client only) - Acquire write file descriptor and MTU and lock - write access to the characteristic. + 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 WriteAcquired property which relies on @@ -115,8 +116,9 @@ Methods array{byte} ReadValue(dict options) fd, uint16 AcquireNotify() [experimental] (Client only) - Acquire notify file descriptor and MTU and lock - notifications to the characteristic. + Acquire file descriptor and MTU for notify. Usage of + StartNotify will be locked causing it to return + NotPermitted error. Only works with characteristic that has NotifyAcquired which relies on notify Flag and no other client have @@ -125,7 +127,7 @@ Methods array{byte} ReadValue(dict options) Notification are enabled during this procedure so StartNotify shall not be called, any notification will be dispatched via file descriptor therefore the - Value property is no affected during the time where + Value property is not affected during the time where notify has been acquired. To release the lock the client shall close the file @@ -147,6 +149,7 @@ Methods array{byte} ReadValue(dict options) if it supports value notifications or indications. Possible Errors: org.bluez.Error.Failed + org.bluez.Error.NotPermitted org.bluez.Error.InProgress org.bluez.Error.NotSupported @@ -177,15 +180,15 @@ Properties string UUID [read-only] boolean WriteAcquired [read-only, optional] - True, if this characteristic has been acquire by any + 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. + in case 'write-without-response' flag is not set. boolean NotifyAcquired [read-only, optional] - True, if this characteristic has been acquire by any + True, if this characteristic has been acquired by any client using AcquireNotify. This properties is ommited - in case notify flag is not set. + in case 'notify' flag is not set. boolean Notifying [read-only, optional] |