diff mbox series

[BlueZ,1/3] doc/adapter-api: Add pattern filter

Message ID 20200220002824.8819-1-luiz.dentz@gmail.com (mailing list archive)
State Accepted
Delegated to: Luiz Von Dentz
Headers show
Series [BlueZ,1/3] doc/adapter-api: Add pattern filter | expand

Commit Message

Luiz Augusto von Dentz Feb. 20, 2020, 12:28 a.m. UTC
From: Luiz Augusto von Dentz <luiz.von.dentz@intel.com>

This adds a pattern filter which can be used to filter devices by
address or name prefix which is quite convenient on a crowded
 doc/adapter-api.txt | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
diff mbox series


diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index 2afd61bc3..acae032d9 100644
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@@ -119,6 +119,21 @@  Methods		void StartDiscovery()
 				if the adapter is already discoverable setting
 				this filter won't do anything.
+			string Pattern (Default: none)
+				Discover devices where the pattern matches
+				either the prefix of the address or
+				device name which is convenient way to limited
+				the number of device objects created during a
+				discovery.
+				When set disregards device discoverable flags.
+				Note: The pattern matching is ignored if there
+				are other client that don't set any pattern as
+				it work as a logical OR, also setting empty
+				string "" pattern will match any device found.
 			When discovery filter is set, Device objects will be
 			created as new devices with matching criteria are
 			discovered regardless of they are connectable or