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

Commit 694f2b84 authored by Paul Jensen's avatar Paul Jensen
Browse files

Add ConnectivityManager.registerNetworkCallback(NetworkRequest, PendingIntent) 

Without this API we're more or less encouraging apps to have long running
processes (battery draining) to receive NetworkCallbacks for the stateful
NetworkCapabilities NET_CAPABILITIES_VALIDATED and
NET_CAPABILITIES_CAPTIVE_PORTAL.  With this API they can instead using
PendingIntents which outlive their apps.

Bug: 21343774
Change-Id: I168d0ac3757729acf7ca5546079846f575a0eedd
parent fd9a2daf

api/current.txt

+1 −0
Original line number Diff line number Diff line
@@ -18164,6 +18164,7 @@ package android.net { 
    method public boolean isDefaultNetworkActive();

    method public static deprecated boolean isNetworkTypeValid(int);

    method public void registerNetworkCallback(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback);

    method public void registerNetworkCallback(android.net.NetworkRequest, android.app.PendingIntent);

    method public void releaseNetworkRequest(android.app.PendingIntent);

    method public void removeDefaultNetworkActiveListener(android.net.ConnectivityManager.OnNetworkActiveListener);

    method public deprecated void reportBadNetwork(android.net.Network);

api/system-current.txt

+1 −0
Original line number Diff line number Diff line
@@ -19658,6 +19658,7 @@ package android.net { 
    method public boolean isDefaultNetworkActive();

    method public static deprecated boolean isNetworkTypeValid(int);

    method public void registerNetworkCallback(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback);

    method public void registerNetworkCallback(android.net.NetworkRequest, android.app.PendingIntent);

    method public void releaseNetworkRequest(android.app.PendingIntent);

    method public void removeDefaultNetworkActiveListener(android.net.ConnectivityManager.OnNetworkActiveListener);

    method public deprecated void reportBadNetwork(android.net.Network);

core/java/android/net/ConnectivityManager.java

+39 −1
Original line number Diff line number Diff line
@@ -2513,7 +2513,7 @@ public class ConnectivityManager { 
     * Intent to reserve the network or it will be released shortly after the Intent

     * is processed.

     * <p>

     * If there is already an request for this Intent registered (with the equality of

     * If there is already a request for this Intent registered (with the equality of

     * two Intents defined by {@link Intent#filterEquals}), then it will be removed and

     * replaced by this one, effectively releasing the previous {@link NetworkRequest}.

     * <p>
@@ -2572,6 +2572,44 @@ public class ConnectivityManager { 
        sendRequestForNetwork(request.networkCapabilities, networkCallback, 0, LISTEN, TYPE_NONE);

    }



    /**

     * Registers a PendingIntent to be sent when a network is available which satisfies the given

     * {@link NetworkRequest}.

     *

     * This function behaves identically to the version that takes a NetworkCallback, but instead

     * of {@link NetworkCallback} a {@link PendingIntent} is used.  This means

     * the request may outlive the calling application and get called back when a suitable

     * network is found.

     * <p>

     * The operation is an Intent broadcast that goes to a broadcast receiver that

     * you registered with {@link Context#registerReceiver} or through the

     * &lt;receiver&gt; tag in an AndroidManifest.xml file

     * <p>

     * The operation Intent is delivered with two extras, a {@link Network} typed

     * extra called {@link #EXTRA_NETWORK} and a {@link NetworkRequest}

     * typed extra called {@link #EXTRA_NETWORK_REQUEST} containing

     * the original requests parameters.

     * <p>

     * If there is already a request for this Intent registered (with the equality of

     * two Intents defined by {@link Intent#filterEquals}), then it will be removed and

     * replaced by this one, effectively releasing the previous {@link NetworkRequest}.

     * <p>

     * The request may be released normally by calling

     * {@link #releaseNetworkRequest(android.app.PendingIntent)}.

     * <p>This method requires the caller to hold the permission

     * {@link android.Manifest.permission#ACCESS_NETWORK_STATE}.

     * @param request {@link NetworkRequest} describing this request.

     * @param operation Action to perform when the network is available (corresponds

     *                  to the {@link NetworkCallback#onAvailable} call.  Typically

     *                  comes from {@link PendingIntent#getBroadcast}. Cannot be null.

     */

    public void registerNetworkCallback(NetworkRequest request, PendingIntent operation) {

        checkPendingIntent(operation);

        try {

            mService.pendingListenForNetwork(request.networkCapabilities, operation);

        } catch (RemoteException e) {}

    }



    /**

     * Requests bandwidth update for a given {@link Network} and returns whether the update request

     * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying

services/core/java/com/android/server/ConnectivityService.java

+21 −2
Original line number Diff line number Diff line
@@ -324,7 +324,7 @@ public class ConnectivityService extends IConnectivityManager.Stub 


    /**

     * used to add a network request with a pending intent

     * includes a NetworkRequestInfo

     * obj = NetworkRequestInfo

     */

    private static final int EVENT_REGISTER_NETWORK_REQUEST_WITH_INTENT = 26;
@@ -354,6 +354,12 @@ public class ConnectivityService extends IConnectivityManager.Stub 
     */

    private static final int EVENT_CONFIGURE_MOBILE_DATA_ALWAYS_ON = 30;



    /**

     * used to add a network listener with a pending intent

     * obj = NetworkRequestInfo

     */

    private static final int EVENT_REGISTER_NETWORK_LISTENER_WITH_INTENT = 31;



    /** Handler used for internal events. */

    final private InternalHandler mHandler;

    /** Handler used for incoming {@link NetworkStateTracker} events. */
@@ -2524,7 +2530,8 @@ public class ConnectivityService extends IConnectivityManager.Stub 
                    handleRegisterNetworkRequest((NetworkRequestInfo) msg.obj);

                    break;

                }

                case EVENT_REGISTER_NETWORK_REQUEST_WITH_INTENT: {

                case EVENT_REGISTER_NETWORK_REQUEST_WITH_INTENT:

                case EVENT_REGISTER_NETWORK_LISTENER_WITH_INTENT: {

                    handleRegisterNetworkRequestWithIntent(msg);

                    break;

                }
@@ -3760,6 +3767,18 @@ public class ConnectivityService extends IConnectivityManager.Stub 
    @Override

    public void pendingListenForNetwork(NetworkCapabilities networkCapabilities,

            PendingIntent operation) {

        checkNotNull(operation, "PendingIntent cannot be null.");

        if (!hasWifiNetworkListenPermission(networkCapabilities)) {

            enforceAccessPermission();

        }



        NetworkRequest networkRequest = new NetworkRequest(new NetworkCapabilities(

                networkCapabilities), TYPE_NONE, nextNetworkRequestId());

        if (DBG) log("pendingListenForNetwork for " + networkRequest + " to trigger " + operation);

        NetworkRequestInfo nri = new NetworkRequestInfo(networkRequest, operation,

                NetworkRequestInfo.LISTEN);



        mHandler.sendMessage(mHandler.obtainMessage(EVENT_REGISTER_NETWORK_LISTENER, nri));

    }



    @Override