linux-bluetooth.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Anderson Lizardo <anderson.lizardo@openbossa.org>
To: linux-bluetooth@vger.kernel.org
Cc: Claudio Takahasi <claudio.takahasi@openbossa.org>
Subject: [RFC BlueZ 7/7] doc: Add Register/Unregister GATT based services
Date: Mon, 23 Jul 2012 11:55:20 -0400	[thread overview]
Message-ID: <1343058920-18608-8-git-send-email-anderson.lizardo@openbossa.org> (raw)
In-Reply-To: <1343058920-18608-1-git-send-email-anderson.lizardo@openbossa.org>

From: Claudio Takahasi <claudio.takahasi@openbossa.org>

This patch extends the Service interface to allow applications to
register and unregister GATT based services.
---
 doc/service-api.txt |   33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/doc/service-api.txt b/doc/service-api.txt
index 0139f5f..1380932 100644
--- a/doc/service-api.txt
+++ b/doc/service-api.txt
@@ -43,6 +43,39 @@ Methods		uint32 AddRecord(string record)
 					 org.bluez.Error.DoesNotExist
 					 org.bluez.Error.Failed
 
+		void Register(string uuid, dict settings,
+					array{object} characteristics)
+
+			Add a GATT based service. The uuid represents the
+			primary/secondary service UUID. The settings
+			dictionary has the following format:
+			{
+				"id": string (optional)
+			}
+
+			settings field is being added to allow API
+			flexibility. The "id" field allows the core to
+			manage handle allocation and internal GATT storage.
+
+			GATT included services is supported by providing the
+			same characteristic object path (restricted to same
+			provider/owner).
+
+			The characteristic objects implemented by the
+			caller shall follow the interface defined in the
+			attribute API.
+
+			Possible errors: org.bluez.Error.InvalidArguments
+					 org.bluez.Error.AlreadyExists
+
+		void Unregister(string uuid)
+
+			Removes a given GATT based service previously
+			registered by the caller.
+
+			Possible errors: org.bluez.Error.InvalidArguments
+					 org.bluez.Error.NotAuthorized
+
 		void RegisterWatcher(object agent, dict settings,
 						array{object} characteristics)
 
-- 
1.7.9.5


  parent reply	other threads:[~2012-07-23 15:55 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-07-23 15:55 [RFC BlueZ 0/7] Generic GATT API changes Anderson Lizardo
2012-07-23 15:55 ` [RFC BlueZ 1/7] attrib-api: Remove local service hierarchy Anderson Lizardo
2012-07-23 15:55 ` [RFC BlueZ 2/7] attrib-api: Update introduction text Anderson Lizardo
2012-07-23 15:55 ` [RFC BlueZ 3/7] attrib-api: Remove GATT service hierarchy Anderson Lizardo
2012-07-23 15:55 ` [RFC BlueZ 4/7] attrib-api: Update Characteristic interface Anderson Lizardo
2012-07-23 15:55 ` [RFC BlueZ 5/7] attrib-api: Update Watcher interface methods Anderson Lizardo
2012-07-23 15:55 ` [RFC BlueZ 6/7] attrib-api: Add RegisterWatcher/UnregisterWatcher methods Anderson Lizardo
2012-07-23 15:55 ` Anderson Lizardo [this message]
2012-07-24  9:27   ` [RFC BlueZ 7/7] doc: Add Register/Unregister GATT based services Johan Hedberg
2012-07-24  9:53 ` [RFC BlueZ 0/7] Generic GATT API changes Johan Hedberg

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=1343058920-18608-8-git-send-email-anderson.lizardo@openbossa.org \
    --to=anderson.lizardo@openbossa.org \
    --cc=claudio.takahasi@openbossa.org \
    --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;
as well as URLs for NNTP newsgroup(s).