Merge "Address ConnectivityManager API comments." am: b5d6e45e8d (08ab9ea5) · Commits · e / os / android_frameworks_base

api/current.txt

+2 −2

Original line number	Diff line number	Diff line
		@@ -23784,8 +23784,8 @@ package android.net {
		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, android.net.ConnectivityManager.NetworkCallback, android.os.Handler);
		method public void requestNetwork(android.net.NetworkRequest, int, android.net.ConnectivityManager.NetworkCallback);
		method public void requestNetwork(android.net.NetworkRequest, int, android.net.ConnectivityManager.NetworkCallback, android.os.Handler);
		method public void requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback, int);
		method public void requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback, android.os.Handler, int);
		method public void requestNetwork(android.net.NetworkRequest, android.app.PendingIntent);
		method public deprecated boolean requestRouteToHost(int, int);
		method public deprecated void setNetworkPreference(int);

api/system-current.txt

+2 −2

Original line number	Diff line number	Diff line
		@@ -25572,8 +25572,8 @@ package android.net {
		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, android.net.ConnectivityManager.NetworkCallback, android.os.Handler);
		method public void requestNetwork(android.net.NetworkRequest, int, android.net.ConnectivityManager.NetworkCallback);
		method public void requestNetwork(android.net.NetworkRequest, int, android.net.ConnectivityManager.NetworkCallback, android.os.Handler);
		method public void requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback, int);
		method public void requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback, android.os.Handler, int);
		method public void requestNetwork(android.net.NetworkRequest, android.app.PendingIntent);
		method public deprecated boolean requestRouteToHost(int, int);
		method public deprecated void setNetworkPreference(int);

api/test-current.txt

+2 −2

Original line number	Diff line number	Diff line
		@@ -23858,8 +23858,8 @@ package android.net {
		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, android.net.ConnectivityManager.NetworkCallback, android.os.Handler);
		method public void requestNetwork(android.net.NetworkRequest, int, android.net.ConnectivityManager.NetworkCallback);
		method public void requestNetwork(android.net.NetworkRequest, int, android.net.ConnectivityManager.NetworkCallback, android.os.Handler);
		method public void requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback, int);
		method public void requestNetwork(android.net.NetworkRequest, android.net.ConnectivityManager.NetworkCallback, android.os.Handler, int);
		method public void requestNetwork(android.net.NetworkRequest, android.app.PendingIntent);
		method public deprecated boolean requestRouteToHost(int, int);
		method public deprecated void setNetworkPreference(int);

core/java/android/net/ConnectivityManager.java

+12 −56

Original line number	Diff line number	Diff line
		@@ -2648,7 +2648,7 @@ public class ConnectivityManager {

		/**
		* Called if no network is found in the timeout time specified in
		* {@link #requestNetwork(NetworkRequest, int, NetworkCallback)} call. This callback is not
		* {@link #requestNetwork(NetworkRequest, NetworkCallback, int)} 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
		@@ -2945,7 +2945,7 @@ public class ConnectivityManager {
		* This {@link NetworkRequest} will live until released via
		* {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits. A
		* version of the method which takes a timeout is
		* {@link #requestNetwork(NetworkRequest, int, NetworkCallback)}.
		* {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}.
		* 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.
		@@ -2980,7 +2980,7 @@ public class ConnectivityManager {
		* This {@link NetworkRequest} will live until released via
		* {@link #unregisterNetworkCallback(NetworkCallback)} or the calling application exits. A
		* version of the method which takes a timeout is
		* {@link #requestNetwork(NetworkRequest, int, NetworkCallback)}.
		* {@link #requestNetwork(NetworkRequest, NetworkCallback, int)}.
		* 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.
		@@ -3013,11 +3013,6 @@ 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.
		*
		@@ -3030,7 +3025,7 @@ public class ConnectivityManager {
		* 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
		* 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
		@@ -3039,13 +3034,11 @@ public class ConnectivityManager {
		* {@link android.provider.Settings.System#canWrite}.</p>
		*
		* @param request {@link NetworkRequest} describing this request.
		* @param networkCallback The callbacks to be utilized for this request. Note
		* the callbacks must not be shared - they uniquely specify
		* 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. The timeout must
		* be a positive value (i.e. >0).
		* @hide
		*/
		public void requestNetwork(NetworkRequest request, NetworkCallback networkCallback,
		int timeoutMs) {
		@@ -3056,43 +3049,6 @@ public class ConnectivityManager {
		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());
		}


		/**
		* Request a network to satisfy a set of {@link android.net.NetworkCapabilities}, limited
		@@ -3115,14 +3071,14 @@ public class ConnectivityManager {
		* {@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.
		* @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.
		* @param timeoutMs The time in milliseconds to attempt looking for a suitable network
		* before {@link NetworkCallback#onUnavailable} is called.
		*/
		public void requestNetwork(NetworkRequest request, int timeoutMs,
		NetworkCallback networkCallback, Handler handler) {
		public void requestNetwork(NetworkRequest request, NetworkCallback networkCallback,
		Handler handler, int timeoutMs) {
		if (timeoutMs <= 0) {
		throw new IllegalArgumentException("Non-positive timeoutMs");
		}
		@@ -3487,8 +3443,8 @@ public class ConnectivityManager {
		/**
		* It is acceptable to briefly use multipath data to provide seamless connectivity for
		* time-sensitive user-facing operations when the system default network is temporarily
		* unresponsive. The amount of data should be limited (less than one megabyte), and the
		* operation should be infrequent to ensure that data usage is limited.
		* unresponsive. The amount of data should be limited (less than one megabyte for every call to
		* this method), and the operation should be infrequent to ensure that data usage is limited.
		*
		* An example of such an operation might be a time-sensitive foreground activity, such as a
		* voice command, that the user is performing while walking out of range of a Wi-Fi network.