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.

Signed-off-by: Anuj Jain <anuj01.jain@samsung.com>
Signed-off-by: Ayush Garg <ayush.garg@samsung.com>

diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt
index fae9bae..1550d6f 100755 (executable)
--- a/doc/mgmt-api.txt
+++ b/doc/mgmt-api.txt
@@ -4152,6 +4152,7 @@ Device Connected Event
                1       Legacy Pairing
                2       Reserved (not in use)
                3       Initiated Connection
+               4       Reserved (not in use)
 
 
 Device Disconnected Event
@@ -4326,6 +4327,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
@@ -4348,6 +4350,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 e0e0409..0e1e7a9 100755 (executable)
--- a/doc/settings-storage.txt
+++ b/doc/settings-storage.txt
@@ -189,7 +189,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).
@@ -203,6 +203,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
@@ -257,6 +260,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
 ================