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

Commit 92c8f596 authored by lesl's avatar lesl Committed by Les Lee
Browse files

wifi: Update API java to match new design 

Update the java doc to match new behavior as below:

ClientControlByUserEnabled (true)
-> disconnect new/unknown MAC + Callback;
New clients will need to attempt again and
will be allowed/disallowed based on user action
in the previous callback.

ClientControlByUserEnabled (false=default)
-> allow new/unknown MAC + Callback;
New clients will not disconnect unless the user
chooses to disallow the client by adding to the blocklist.

Bug: 159582750
Test: atest FrameworksWifiTests
Test: make docs frameworks/base/wifi/
Change-Id: I64a85db0a28342003f902c50f81531b2218a6252
parent e658c76b

wifi/java/android/net/wifi/SoftApConfiguration.java

+13 −14
Original line number Original line Diff line number Diff line
@@ -885,7 +885,8 @@ public final class SoftApConfiguration implements Parcelable { 




        /**

        /**

         * Configure the Soft AP to require manual user control of client association.

         * Configure the Soft AP to require manual user control of client association.

         * If disabled (the default) then any client can associate to this Soft AP using the

         * If disabled (the default) then any client which isn't in the blocked list

         * {@link #getBlockedClientList()} can associate to this Soft AP using the

         * correct credentials until the Soft AP capacity is reached (capacity is hardware, carrier,

         * correct credentials until the Soft AP capacity is reached (capacity is hardware, carrier,

         * or user limited - using {@link #setMaxNumberOfClients(int)}).

         * or user limited - using {@link #setMaxNumberOfClients(int)}).

         *

         *
@@ -945,21 +946,19 @@ public final class SoftApConfiguration implements Parcelable { 
        }

        }





        /**

        /**

         * This method together with {@link setClientControlByUserEnabled(boolean)} control client

         * This API configures the list of clients which are blocked and cannot associate

         * connections to the AP. If client control by user is disabled using the above method then

         * to the Soft AP.

         * this API has no effect and clients are allowed to associate to the AP (within limit of

         * max number of clients).

         *

         *

         * If client control by user is enabled then this API this API configures the list of

         * <p>

         * clients which are blocked. These are rejected.

         * This method requires hardware support. Hardware support can be determined using

         * {@link WifiManager.SoftApCallback#onCapabilityChanged(SoftApCapability)} and

         * {@link SoftApCapability#areFeaturesSupported(int)}

         * with {@link SoftApCapability.SOFTAP_FEATURE_CLIENT_FORCE_DISCONNECT}

         *

         *

         * All other clients which attempt to associate, whose MAC addresses are on neither list,

         * <p>

         * are:

         * If the method is called on a device without hardware support then starting the soft AP

         * <ul>

         * using {@link WifiManager#startTetheredHotspot(SoftApConfiguration)} will fail with

         * <li>Rejected</li>

         * {@link WifiManager#SAP_START_FAILURE_UNSUPPORTED_CONFIGURATION}.

         * <li>A callback {@link WifiManager.SoftApCallback#onBlockedClientConnecting(WifiClient)}

         * is issued (which allows the user to add them to the allowed client list if desired).<li>

         * </ul>

         *

         *

         * @param blockedClientList list of clients which are not allowed to associate to the AP.

         * @param blockedClientList list of clients which are not allowed to associate to the AP.

         * @return Builder for chaining.

         * @return Builder for chaining.