public inbox for linux-bluetooth@vger.kernel.org
 help / color / mirror / Atom feed
From: Luiz Augusto von Dentz <luiz.dentz@gmail.com>
To: linux-bluetooth@vger.kernel.org
Subject: [PATCH BlueZ 03/10] doc/gatt-api: Add server support for AcquireWrite and AcquireNotify
Date: Mon, 18 Sep 2017 15:39:54 +0300	[thread overview]
Message-ID: <20170918124001.2617-4-luiz.dentz@gmail.com> (raw)
In-Reply-To: <20170918124001.2617-1-luiz.dentz@gmail.com>

From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>

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.
---
 doc/gatt-api.txt | 22 ++++++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/doc/gatt-api.txt b/doc/gatt-api.txt
index cdd15f301..6f82c9fc1 100644
--- a/doc/gatt-api.txt
+++ b/doc/gatt-api.txt
@@ -91,12 +91,15 @@ 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.
 
+			For server the MTU returned shall be equal or smaller
+			than the negotiated MTU.
+
 			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
 
@@ -191,12 +203,18 @@ Properties	string UUID [read-only]
 			client using AcquireWrite. This 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.
 
+			For server the presence of this property indicates
+			that AcquireNotify is supported.
+
 		boolean Notifying [read-only, optional]
 
 			True, if notifications or indications on this
-- 
2.13.5


  parent reply	other threads:[~2017-09-18 12:39 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-18 12:39 [PATCH BlueZ 00/10] gatt: Add server support for AcquireWrite and AcquireNotify Luiz Augusto von Dentz
2017-09-18 12:39 ` [PATCH BlueZ 01/10] gatt: Remove useless debug Luiz Augusto von Dentz
2017-09-18 12:39 ` [PATCH BlueZ 02/10] client: Rework variables for AcquireWrite/AcquireNotify Luiz Augusto von Dentz
2017-09-18 12:39 ` Luiz Augusto von Dentz [this message]
2017-09-18 12:39 ` [PATCH BlueZ 04/10] shared/gatt-server: Add bt_gatt_server_get_mtu Luiz Augusto von Dentz
2017-09-18 12:39 ` [PATCH BlueZ 05/10] shared/gatt-db: Add gatt_db_attribute_get_user_data Luiz Augusto von Dentz
2017-09-18 12:39 ` [PATCH BlueZ 06/10] gatt: Implement AcquireWrite for server Luiz Augusto von Dentz
2017-09-18 12:39 ` [PATCH BlueZ 07/10] client: " Luiz Augusto von Dentz
2017-09-19  4:14   ` Yunhan Wang
2017-09-19  9:57     ` Luiz Augusto von Dentz
2017-09-18 12:39 ` [PATCH BlueZ 08/10] gatt: Implement AcquireNotify " Luiz Augusto von Dentz
2017-09-18 12:40 ` [PATCH BlueZ 09/10] client: " Luiz Augusto von Dentz
2017-09-18 12:40 ` [PATCH BlueZ 10/10] gatt: Update signature of AcquireWrite and AcquireNotify Luiz Augusto von Dentz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170918124001.2617-4-luiz.dentz@gmail.com \
    --to=luiz.dentz@gmail.com \
    --cc=linux-bluetooth@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox