Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Wifi: Update to the WifiLock API documentation

Browse Source 
This commit provides an update to the WifiLock types API documentation.
It adds the condition of the device to be connected to an access point
for lock to be active. This applies to both high perf and low latency
locks.

Bug: 127884567
Test: None
Change-Id: If65681939058a5d6508cf0a970517fa856cc04b3
This commit is contained in:
Ahmed ElArabawy
2019-03-13 13:50:49 -07:00
parent ab3957afd1
commit 8fb283da77
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
wifi/java/android/net/wifi/WifiManager.java
View File

@@ -1001,8 +1001,9 @@ public class WifiManager {
/**
* In this Wi-Fi lock mode, Wi-Fi will not go to power save.
* This results in operating with low packet latency.
* The lock is active even when the device screen is off or
* the acquiring application is running in the background.
* The lock is only active when the device is connected to an access point.
* The lock is active even when the device screen is off or the acquiring application is
* running in the background.
* This mode will consume more power and hence should be used only
* when there is a need for this tradeoff.
* <p>
@@ -1020,6 +1021,7 @@ public class WifiManager {
* In this Wi-Fi lock mode, Wi-Fi will operate with a priority to achieve low latency.
* {@link #WIFI_MODE_FULL_LOW_LATENCY} lock has the following limitations:
* <ol>
* <li>The lock is only active when the device is connected to an access point.</li>
* <li>The lock is only active when the screen is on.</li>
* <li>The lock is only active when the acquiring app is running in the foreground.</li>
* </ol>