Merge "[CM] Allow timeout in request network" (645b48c8) · Commits · e / os / android_frameworks_base

api/current.txt

+2 −0

Original line number	Diff line number	Diff line
		@@ -23644,6 +23644,7 @@ package android.net {
		method public void reportNetworkConnectivity(android.net.Network, boolean);
		method public boolean requestBandwidthUpdate(android.net.Network);
		method public void requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback);
		method public void requestNetwork(android.net.NetworkRequest, int, android.net.ConnectivityManager.NetworkCallback);
		method public void requestNetwork(android.net.NetworkRequest, android.app.PendingIntent);
		method public deprecated boolean requestRouteToHost(int, int);
		method public deprecated void setNetworkPreference(int);
		@@ -23691,6 +23692,7 @@ package android.net {
		method public void onLinkPropertiesChanged(android.net.Network, android.net.LinkProperties);
		method public void onLosing(android.net.Network, int);
		method public void onLost(android.net.Network);
		method public void onUnavailable();
		}

		public static abstract interface ConnectivityManager.OnNetworkActiveListener {

api/system-current.txt

+2 −0

Original line number	Diff line number	Diff line
		@@ -25431,6 +25431,7 @@ package android.net {
		method public void reportNetworkConnectivity(android.net.Network, boolean);
		method public boolean requestBandwidthUpdate(android.net.Network);
		method public void requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback);
		method public void requestNetwork(android.net.NetworkRequest, int, android.net.ConnectivityManager.NetworkCallback);
		method public void requestNetwork(android.net.NetworkRequest, android.app.PendingIntent);
		method public deprecated boolean requestRouteToHost(int, int);
		method public deprecated void setNetworkPreference(int);
		@@ -25484,6 +25485,7 @@ package android.net {
		method public void onLinkPropertiesChanged(android.net.Network, android.net.LinkProperties);
		method public void onLosing(android.net.Network, int);
		method public void onLost(android.net.Network);
		method public void onUnavailable();
		}

		public static abstract interface ConnectivityManager.OnNetworkActiveListener {

api/test-current.txt

+2 −0

Original line number	Diff line number	Diff line
		@@ -23718,6 +23718,7 @@ package android.net {
		method public void reportNetworkConnectivity(android.net.Network, boolean);
		method public boolean requestBandwidthUpdate(android.net.Network);
		method public void requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback);
		method public void requestNetwork(android.net.NetworkRequest, int, android.net.ConnectivityManager.NetworkCallback);
		method public void requestNetwork(android.net.NetworkRequest, android.app.PendingIntent);
		method public deprecated boolean requestRouteToHost(int, int);
		method public deprecated void setNetworkPreference(int);
		@@ -23765,6 +23766,7 @@ package android.net {
		method public void onLinkPropertiesChanged(android.net.Network, android.net.LinkProperties);
		method public void onLosing(android.net.Network, int);
		method public void onLost(android.net.Network);
		method public void onUnavailable();
		}

		public static abstract interface ConnectivityManager.OnNetworkActiveListener {

core/java/android/net/ConnectivityManager.java

+88 −20

Original line number	Diff line number	Diff line
		@@ -2614,10 +2614,12 @@ public class ConnectivityManager {
		public void onLost(Network network) {}

		/**
		* Called if no network is found in the given timeout time. If no timeout is given,
		* this will not be called. The associated {@link NetworkRequest} will have already
		* been removed and released, as if {@link #unregisterNetworkCallback} had been called.
		* @hide
		* Called if no network is found in the timeout time specified in
		* {@link #requestNetwork(NetworkRequest, int, NetworkCallback)} call. This callback is not
		* called for the version of {@link #requestNetwork(NetworkRequest, NetworkCallback)}
		* without timeout. When this callback is invoked the associated
		* {@link NetworkRequest} will have already been removed and released, as if
		* {@link #unregisterNetworkCallback(NetworkCallback)} had been called.
		*/
		public void onUnavailable() {}

		@@ -2900,7 +2902,9 @@ public class ConnectivityManager {
		* Request a network to satisfy a set of {@link android.net.NetworkCapabilities}.
		*
		* This {@link NetworkRequest} will live until released via
		* {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits.
		* {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits. A
		* version of the method which takes a timeout is
		* {@link #requestNetwork(NetworkRequest, int, NetworkCallback)}.
		* Status of the request can be followed by listening to the various
		* callbacks described in {@link NetworkCallback}. The {@link Network}
		* can be used to direct traffic to the network.
		@@ -2933,7 +2937,9 @@ public class ConnectivityManager {
		* Request a network to satisfy a set of {@link android.net.NetworkCapabilities}.
		*
		* This {@link NetworkRequest} will live until released via
		* {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits.
		* {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits. A
		* version of the method which takes a timeout is
		* {@link #requestNetwork(NetworkRequest, int, NetworkCallback)}.
		* Status of the request can be followed by listening to the various
		* callbacks described in {@link NetworkCallback}. The {@link Network}
		* can be used to direct traffic to the network.
		@@ -2967,13 +2973,25 @@ public class ConnectivityManager {
		}

		/**
		* Note: this is a deprecated version of
		* {@link #requestNetwork(NetworkRequest, int, NetworkCallback)} - please transition code to use
		* the unhidden version of the function.
		* TODO: replace all callers with the new version of the API
		*
		* Request a network to satisfy a set of {@link android.net.NetworkCapabilities}, limited
		* by a timeout.
		*
		* This function behaves identically to the non-timedout version, but if a suitable
		* network is not found within the given time (in milliseconds) the
		* {@link NetworkCallback#onUnavailable()} callback is called. The request must
		* still be released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)}.
		* This function behaves identically to the non-timed-out version
		* {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network
		* is not found within the given time (in milliseconds) the
		* {@link NetworkCallback#onUnavailable()} callback is called. The request can still be
		* released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
		* not have to be released if timed-out (it is automatically released). Unregistering a
		* request that timed out is not an error.
		*
		* <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
		* timeout) - the {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
		* for that purpose. Calling this method will attempt to bring up the requested network.
		*
		* <p>This method requires the caller to hold either the
		* {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
		@@ -2981,15 +2999,56 @@ public class ConnectivityManager {
		* {@link android.provider.Settings.System#canWrite}.</p>
		*
		* @param request {@link NetworkRequest} describing this request.
		* @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
		* the callback must not be shared - it uniquely specifies this request.
		* The callback is invoked on the default internal Handler.
		* @param networkCallback The callbacks to be utilized for this request. Note
		* the callbacks must not be shared - they uniquely specify
		* this request.
		* @param timeoutMs The time in milliseconds to attempt looking for a suitable network
		* before {@link NetworkCallback#onUnavailable()} is called.
		* before {@link NetworkCallback#onUnavailable()} is called. The timeout must
		* be a positive value (i.e. >0).
		* @hide
		*/
		public void requestNetwork(NetworkRequest request, NetworkCallback networkCallback,
		int timeoutMs) {
		if (timeoutMs <= 0) {
		throw new IllegalArgumentException("Non-positive timeoutMs: " + timeoutMs);
		}
		int legacyType = inferLegacyTypeForNetworkCapabilities(request.networkCapabilities);
		requestNetwork(request, networkCallback, timeoutMs, legacyType, getDefaultHandler());
		}

		/**
		* Request a network to satisfy a set of {@link android.net.NetworkCapabilities}, limited
		* by a timeout.
		*
		* This function behaves identically to the non-timed-out version
		* {@link #requestNetwork(NetworkRequest, NetworkCallback)}, but if a suitable network
		* is not found within the given time (in milliseconds) the
		* {@link NetworkCallback#onUnavailable()} callback is called. The request can still be
		* released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
		* not have to be released if timed-out (it is automatically released). Unregistering a
		* request that timed out is not an error.
		*
		* <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
		* timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
		* for that purpose. Calling this method will attempt to bring up the requested network.
		*
		* <p>This method requires the caller to hold either the
		* {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
		* or the ability to modify system settings as determined by
		* {@link android.provider.Settings.System#canWrite}.</p>
		*
		* @param request {@link NetworkRequest} describing this request.
		* @param timeoutMs The time in milliseconds to attempt looking for a suitable network
		* before {@link NetworkCallback#onUnavailable()} is called. The timeout must
		* be a positive value (i.e. >0).
		* @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
		* the callback must not be shared - it uniquely specifies this request.
		*/
		public void requestNetwork(NetworkRequest request, int timeoutMs,
		NetworkCallback networkCallback) {
		if (timeoutMs <= 0) {
		throw new IllegalArgumentException("Non-positive timeoutMs: " + timeoutMs);
		}
		int legacyType = inferLegacyTypeForNetworkCapabilities(request.networkCapabilities);
		requestNetwork(request, networkCallback, timeoutMs, legacyType, getDefaultHandler());
		}
		@@ -3001,8 +3060,14 @@ public class ConnectivityManager {
		*
		* This function behaves identically to the non-timedout version, but if a suitable
		* network is not found within the given time (in milliseconds) the
		* {@link NetworkCallback#onUnavailable} callback is called. The request must
		* still be released normally by calling {@link unregisterNetworkCallback(NetworkCallback)}.
		* {@link NetworkCallback#onUnavailable} callback is called. The request can still be
		* released normally by calling {@link #unregisterNetworkCallback(NetworkCallback)} but does
		* not have to be released if timed-out (it is automatically released). Unregistering a
		* request that timed out is not an error.
		*
		* <p>Do not use this method to poll for the existence of specific networks (e.g. with a small
		* timeout) - {@link #registerNetworkCallback(NetworkRequest, NetworkCallback)} is provided
		* for that purpose. Calling this method will attempt to bring up the requested network.
		*
		* <p>This method requires the caller to hold either the
		* {@link android.Manifest.permission#CHANGE_NETWORK_STATE} permission
		@@ -3010,16 +3075,19 @@ public class ConnectivityManager {
		* {@link android.provider.Settings.System#canWrite}.</p>
		*
		* @param request {@link NetworkRequest} describing this request.
		* @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
		* the callback must not be shared - it uniquely specifies this request.
		* @param timeoutMs The time in milliseconds to attempt looking for a suitable network
		* before {@link NetworkCallback#onUnavailable} is called.
		* @param networkCallback The {@link NetworkCallback} to be utilized for this request. Note
		* the callback must not be shared - it uniquely specifies this request.
		* @param handler {@link Handler} to specify the thread upon which the callback will be invoked.
		*
		* @hide
		*/
		public void requestNetwork(NetworkRequest request, NetworkCallback networkCallback,
		int timeoutMs, Handler handler) {
		public void requestNetwork(NetworkRequest request, int timeoutMs,
		NetworkCallback networkCallback, Handler handler) {
		if (timeoutMs <= 0) {
		throw new IllegalArgumentException("Non-positive timeoutMs");
		}
		int legacyType = inferLegacyTypeForNetworkCapabilities(request.networkCapabilities);
		CallbackHandler cbHandler = new CallbackHandler(handler);
		requestNetwork(request, networkCallback, timeoutMs, legacyType, cbHandler);