From 8fb283da77f7ea8433be4f2cf9379efb108b1a48 Mon Sep 17 00:00:00 2001 From: Ahmed ElArabawy Date: Wed, 13 Mar 2019 13:50:49 -0700 Subject: [PATCH] Wifi: Update to the WifiLock API documentation 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 --- wifi/java/android/net/wifi/WifiManager.java | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/wifi/java/android/net/wifi/WifiManager.java b/wifi/java/android/net/wifi/WifiManager.java index 869f665048a3e..52e03ce5e197c 100644 --- a/wifi/java/android/net/wifi/WifiManager.java +++ b/wifi/java/android/net/wifi/WifiManager.java @@ -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. *

@@ -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: *

    + *
  1. The lock is only active when the device is connected to an access point.
    2. *
  2. The lock is only active when the screen is on.
    3. *
  3. The lock is only active when the acquiring app is running in the foreground.
    4. *