summaryrefslogtreecommitdiff
path: root/doc/gatt-api.txt
diff options
context:
space:
mode:
authorLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2015-12-10 16:46:16 -0200
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2016-01-07 14:56:25 -0300
commitc19813c95ea1eaa990f478b3004db9c1c03632dc (patch)
treeea1c6a6517ba844663f6a5aca675b52255afeabd /doc/gatt-api.txt
parent43657d77037302268b6ef02724c66eda416cf3e7 (diff)
downloadbluez-c19813c95ea1eaa990f478b3004db9c1c03632dc.tar.gz
doc/gatt-api: Make proper use of ObjectManager
ObjectManager path shall not contain other intefaces in its root path, only child objects shall be included with many bindings following this. Due to this limitation and also the fact that application might actually have a single ObjectManager path so all services can be registered at once.
Diffstat (limited to 'doc/gatt-api.txt')
-rw-r--r--doc/gatt-api.txt17
1 files changed, 8 insertions, 9 deletions
diff --git a/doc/gatt-api.txt b/doc/gatt-api.txt
index d832c7316..f1940badd 100644
--- a/doc/gatt-api.txt
+++ b/doc/gatt-api.txt
@@ -270,9 +270,9 @@ must be available on the root service path. An example application hierarchy
containing two separate GATT services may look like this:
-> /com/example
+ | - org.freedesktop.DBus.ObjectManager
|
-> /com/example/service0
- | | - org.freedesktop.DBus.ObjectManager
| | - org.freedesktop.DBus.Properties
| | - org.bluez.GattService1
| |
@@ -289,7 +289,6 @@ containing two separate GATT services may look like this:
| - org.bluez.GattDescriptor1
|
-> /com/example/service1
- | - org.freedesktop.DBus.ObjectManager
| - org.freedesktop.DBus.Properties
| - org.bluez.GattService1
|
@@ -309,21 +308,21 @@ Service org.bluez
Interface org.bluez.GattManager1 [Experimental]
Object path [variable prefix]/{hci0,hci1,...}
-Methods void RegisterService(object service, dict options)
+Methods void RegisterApplication(object application, dict options)
- Registers a local GATT service hierarchy as described
+ Registers a local GATT services hierarchy as described
above.
- "service" object path together with the D-Bus system
- bus connection ID define the identification of the
- application registering a GATT based service.
+ The application object path together with the D-Bus
+ system bus connection ID define the identification of
+ the application registering a GATT based service.
Possible errors: org.bluez.Error.InvalidArguments
org.bluez.Error.AlreadyExists
- void UnregisterService(object service)
+ void UnregisterApplication(object application)
- This unregisters the service that has been
+ This unregisters the services that has been
previously registered. The object path parameter
must match the same value that has been used
on registration.