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

Commit 6dfa74f0 authored by Adam Bookatz's avatar Adam Bookatz
Browse files

Clarify delayed locking documentation 

The documentation on delayed locking had some mistakes and points where
it wasn't clear. We update that here.

Test: N/A. Just javadoc
Change-Id: I2ddee0046229fad703a347b91591a505b54efb83
parent e27fe837

services/core/java/com/android/server/am/UserController.java

+8 −5
Original line number Diff line number Diff line
@@ -993,17 +993,20 @@ class UserController implements Handler.Callback { 
    /**

     * Stops a single User. This can also trigger locking user data out depending on device's

     * config ({@code mDelayUserDataLocking}) and arguments.

     * User will be unlocked when

     * - {@code mDelayUserDataLocking} is not set.

     * - {@code mDelayUserDataLocking} is set and {@code keyEvictedCallback} is non-null.

     *

     * In the default configuration for most device and users, users will be locked when stopping.

     * User will remain unlocked only if all the following are true

     * <li> {@link #canDelayDataLockingForUser(int)} (based on mDelayUserDataLocking) is true

     * <li> the parameter {@code allowDelayedLocking} is true

     * <li> {@code keyEvictedCallback} is null

     * -

     *

     * @param userId User Id to stop and lock the data.

     * @param allowDelayedLocking When set, do not lock user after stopping. Locking can happen

     *                            later when number of unlocked users reaches

     *                            {@code mMaxRunnngUsers}. Note that this is respected only when

     *                            {@code mDelayUserDataLocking} is set and {@keyEvictedCallback} is

     *                            null. Otherwise the user will be locked.

     *                            delayed locking is enabled for this user and {@keyEvictedCallback}

     *                            is null. Otherwise the user nonetheless will be locked.

     * @param stopUserCallback Callback to notify that user has stopped.

     * @param keyEvictedCallback Callback to notify that user has been unlocked.

     */