summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArchie Pusaka <apusaka@chromium.org>2021-11-25 15:06:27 +0800
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2021-11-29 09:43:42 -0800
commitbdf36141b058f078148bef08587e485909efc212 (patch)
treebb1e098fec36212f372b7d24e68ce893cf46610f /doc
parent68e1c426cbc4c4f96fc1a074ad88ca56d8a0a3b0 (diff)
downloadbluez-bdf36141b058f078148bef08587e485909efc212.tar.gz
doc: Add Name Request Fail flag in device found event
Userspace should use this new flag to decide whether to do the remote name resolving or not.
Diffstat (limited to 'doc')
-rw-r--r--doc/mgmt-api.txt7
-rw-r--r--doc/settings-storage.txt11
2 files changed, 17 insertions, 1 deletions
diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt
index 1ab513eb1..ebe56afa4 100644
--- a/doc/mgmt-api.txt
+++ b/doc/mgmt-api.txt
@@ -4090,6 +4090,7 @@ Device Connected Event
1 Legacy Pairing
2 Reserved (not in use)
3 Initiated Connection
+ 4 Reserved (not in use)
Device Disconnected Event
@@ -4264,6 +4265,7 @@ Device Found Event
1 Legacy Pairing
2 Not Connectable
3 Reserved (not in use)
+ 4 Name Request Failed
For the RSSI field a value of 127 indicates that the RSSI is
not available. That can happen with Bluetooth 1.1 and earlier
@@ -4286,6 +4288,11 @@ Device Found Event
accept any connections. This can be indicated by Low Energy
devices that are in broadcaster role.
+ The Name Request Failed flag indicates that name resolving
+ procedure has ended with failure for this device. The user space
+ should use this information to determine when is a good time to
+ retry the name resolving procedure.
+
Discovering Event
=================
diff --git a/doc/settings-storage.txt b/doc/settings-storage.txt
index 3c637c352..26584f201 100644
--- a/doc/settings-storage.txt
+++ b/doc/settings-storage.txt
@@ -179,7 +179,7 @@ Cache directory file format
============================
Each file, named by remote device address, may includes multiple groups
-(General, ServiceRecords, Attributes, Endpoints).
+(General, ServiceRecords, Attributes, Endpoints, NameResolving).
In ServiceRecords, SDP records are stored using their handle as key
(hexadecimal format).
@@ -193,6 +193,9 @@ In "Endpoints" group A2DP remote endpoints are stored using the seid as key
an entry which key is set to "LastUsed" which represented the last endpoint
used.
+In "NameResolving", information regarding remote name resolving are stored to
+prevent wasting time resolving name for unresponsive devices.
+
[General] group contains:
Name String Remote device friendly name
@@ -247,6 +250,12 @@ Sample Attributes section:
local and remote seids as hexadecimal
encoded string.
+[NameResolving] group contains:
+
+ FailedTime Integer The last time we failed to complete name
+ resolving procedure, measured from an
+ arbitrary, fixed point in the past.
+
Info file format
================