Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 8fb283da authored by Ahmed ElArabawy's avatar Ahmed ElArabawy
Browse files

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
parent ab3957af

wifi/java/android/net/wifi/WifiManager.java

+4 −2
Original line number Diff line number Diff line
@@ -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>