[PATCH] adapter-api: Document per-client discovery sessions

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



The fact that each client can start its own discovery wasn't clear from
the documentation and only becomes obvious when reading the sources.
---
 doc/adapter-api.txt | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

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
-- 
2.35.1




[Index of Archives]     [Bluez Devel]     [Linux Wireless Networking]     [Linux Wireless Personal Area Networking]     [Linux ATH6KL]     [Linux USB Devel]     [Linux Media Drivers]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [Big List of Linux Books]

  Powered by Linux