doc/adapter-api: Add pattern filter
Luiz Augusto von Dentz
maintainerPATCH 1/3 doc/adapter-api: Add pattern filter
From: Luiz Augusto von Dentz <[email protected]>
This adds a pattern filter which can be used to filter devices by address or name prefix which is quite convenient on a crowded environment.
--- doc/adapter-api.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+)
doc/adapter-api.txt +15 -0
@@ -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
Signature · 1 line
2.21.1