summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBastien Nocera <hadess@hadess.net>2022-02-23 10:00:59 +0100
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2022-02-23 08:57:23 -0800
commitb086260ac6d4ac765bdc443bb50bd304b0d076c9 (patch)
treef22be88e9bded4f610148178ebaa492a466665ec /doc
parent2e4627c3c92ed823cb976b0a48d5463c2b187fec (diff)
downloadbluez-b086260ac6d4ac765bdc443bb50bd304b0d076c9.tar.gz
adapter-api: Document per-client discovery sessions
The fact that each client can start its own discovery wasn't clear from the documentation and only becomes obvious when reading the sources.
Diffstat (limited to 'doc')
-rw-r--r--doc/adapter-api.txt6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index 490608e8d..48466ab75 100644
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@@ -21,6 +21,9 @@ Methods void StartDiscovery()
During discovery RSSI delta-threshold is imposed.
+ Each client can request a single device discovery session
+ per adapter.
+
Possible errors: org.bluez.Error.NotReady
org.bluez.Error.Failed
org.bluez.Error.InProgress
@@ -32,7 +35,8 @@ Methods void StartDiscovery()
Note that a discovery procedure is shared between all
discovery sessions thus calling StopDiscovery will only
- release a single session.
+ release a single session and discovery will stop when
+ all sessions from all clients have finished.
Possible errors: org.bluez.Error.NotReady
org.bluez.Error.Failed