requestBwUpdate() public API review

Change-Id: I1e780b2705d13bfc85a0a8712ac1dbd623b474a1

2 files changed, 10 insertions, 8 deletions

diff --git a/core/java/android/net/ConnectivityManager.java b/core/java/android/net/ConnectivityManager.java
index b341600..47d5fc6 100644
--- a/core/java/android/net/ConnectivityManager.java
+++ b/core/java/android/net/ConnectivityManager.java
@@ -2452,17 +2452,19 @@ public class ConnectivityManager {
     }
 
     /**
-     * Request connectivityservice to refresh network capabilities for the given
-     * {@link network}. This method returns true if the network is still active, false
-     * otherwise. Notice the method call assumes the caller has registered for
-     * listening NetworkCapabilities updates.
+     * Requests bandwidth update for a given {@link Network} and returns whether the update request
+     * is accepted by ConnectivityService. Once accepted, ConnectivityService will poll underlying
+     * network connection for updated bandwidth information. The caller will be notified via
+     * {@link ConnectivityManager.NetworkCallback} if there is an update. Notice that this
+     * method assumes that the caller has previously called {@link #registerNetworkCallback} to
+     * listen for network changes.
      *
      * @param network{@link Network} specifying which network you're interested.
-     * @hide
+     * @return {@code true} on success, {@code false} if the {@link Network} is no longer valid.
      */
-    public boolean requestBwUpdate(Network network) {
+    public boolean requestBandwidthUpdate(Network network) {
         try {
-            return mService.requestBwUpdate(network);
+            return mService.requestBandwidthUpdate(network);
         } catch (RemoteException e) {
             return false;
         }
diff --git a/core/java/android/net/IConnectivityManager.aidl b/core/java/android/net/IConnectivityManager.aidl
index 9d9b1bf..9152f69 100644
--- a/core/java/android/net/IConnectivityManager.aidl
+++ b/core/java/android/net/IConnectivityManager.aidl
@@ -134,7 +134,7 @@ interface IConnectivityManager
 
     void registerNetworkFactory(in Messenger messenger, in String name);
 
-    boolean requestBwUpdate(in Network network);
+    boolean requestBandwidthUpdate(in Network network);
 
     void unregisterNetworkFactory(in Messenger messenger);