ConnectivityManager.java revision aa3866e6fa2d0c0e026b78cf43dccce67a2021e5
1/* 2 * Copyright (C) 2008 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.net; 18 19import android.annotation.SdkConstant; 20import android.annotation.SdkConstant.SdkConstantType; 21import android.os.Binder; 22import android.os.RemoteException; 23 24import java.net.InetAddress; 25import java.net.UnknownHostException; 26 27/** 28 * Class that answers queries about the state of network connectivity. It also 29 * notifies applications when network connectivity changes. Get an instance 30 * of this class by calling 31 * {@link android.content.Context#getSystemService(String) Context.getSystemService(Context.CONNECTIVITY_SERVICE)}. 32 * <p> 33 * The primary responsibilities of this class are to: 34 * <ol> 35 * <li>Monitor network connections (Wi-Fi, GPRS, UMTS, etc.)</li> 36 * <li>Send broadcast intents when network connectivity changes</li> 37 * <li>Attempt to "fail over" to another network when connectivity to a network 38 * is lost</li> 39 * <li>Provide an API that allows applications to query the coarse-grained or fine-grained 40 * state of the available networks</li> 41 * </ol> 42 */ 43public class ConnectivityManager 44{ 45 /** 46 * A change in network connectivity has occurred. A connection has either 47 * been established or lost. The NetworkInfo for the affected network is 48 * sent as an extra; it should be consulted to see what kind of 49 * connectivity event occurred. 50 * <p/> 51 * If this is a connection that was the result of failing over from a 52 * disconnected network, then the FAILOVER_CONNECTION boolean extra is 53 * set to true. 54 * <p/> 55 * For a loss of connectivity, if the connectivity manager is attempting 56 * to connect (or has already connected) to another network, the 57 * NetworkInfo for the new network is also passed as an extra. This lets 58 * any receivers of the broadcast know that they should not necessarily 59 * tell the user that no data traffic will be possible. Instead, the 60 * reciever should expect another broadcast soon, indicating either that 61 * the failover attempt succeeded (and so there is still overall data 62 * connectivity), or that the failover attempt failed, meaning that all 63 * connectivity has been lost. 64 * <p/> 65 * For a disconnect event, the boolean extra EXTRA_NO_CONNECTIVITY 66 * is set to {@code true} if there are no connected networks at all. 67 */ 68 public static final String CONNECTIVITY_ACTION = "android.net.conn.CONNECTIVITY_CHANGE"; 69 /** 70 * The lookup key for a {@link NetworkInfo} object. Retrieve with 71 * {@link android.content.Intent#getParcelableExtra(String)}. 72 */ 73 public static final String EXTRA_NETWORK_INFO = "networkInfo"; 74 /** 75 * The lookup key for a boolean that indicates whether a connect event 76 * is for a network to which the connectivity manager was failing over 77 * following a disconnect on another network. 78 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}. 79 */ 80 public static final String EXTRA_IS_FAILOVER = "isFailover"; 81 /** 82 * The lookup key for a {@link NetworkInfo} object. This is supplied when 83 * there is another network that it may be possible to connect to. Retrieve with 84 * {@link android.content.Intent#getParcelableExtra(String)}. 85 */ 86 public static final String EXTRA_OTHER_NETWORK_INFO = "otherNetwork"; 87 /** 88 * The lookup key for a boolean that indicates whether there is a 89 * complete lack of connectivity, i.e., no network is available. 90 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}. 91 */ 92 public static final String EXTRA_NO_CONNECTIVITY = "noConnectivity"; 93 /** 94 * The lookup key for a string that indicates why an attempt to connect 95 * to a network failed. The string has no particular structure. It is 96 * intended to be used in notifications presented to users. Retrieve 97 * it with {@link android.content.Intent#getStringExtra(String)}. 98 */ 99 public static final String EXTRA_REASON = "reason"; 100 /** 101 * The lookup key for a string that provides optionally supplied 102 * extra information about the network state. The information 103 * may be passed up from the lower networking layers, and its 104 * meaning may be specific to a particular network type. Retrieve 105 * it with {@link android.content.Intent#getStringExtra(String)}. 106 */ 107 public static final String EXTRA_EXTRA_INFO = "extraInfo"; 108 /** 109 * The lookup key for an int that provides information about 110 * our connection to the internet at large. 0 indicates no connection, 111 * 100 indicates a great connection. Retrieve it with 112 * {@link android.content.Intent@getIntExtra(String)}. 113 * {@hide} 114 */ 115 public static final String EXTRA_INET_CONDITION = "inetCondition"; 116 117 /** 118 * Broadcast Action: The setting for background data usage has changed 119 * values. Use {@link #getBackgroundDataSetting()} to get the current value. 120 * <p> 121 * If an application uses the network in the background, it should listen 122 * for this broadcast and stop using the background data if the value is 123 * false. 124 */ 125 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 126 public static final String ACTION_BACKGROUND_DATA_SETTING_CHANGED = 127 "android.net.conn.BACKGROUND_DATA_SETTING_CHANGED"; 128 129 130 /** 131 * Broadcast Action: The network connection may not be good 132 * uses {@code ConnectivityManager.EXTRA_INET_CONDITION} and 133 * {@code ConnectivityManager.EXTRA_NETWORK_INFO} to specify 134 * the network and it's condition. 135 * @hide 136 */ 137 public static final String INET_CONDITION_ACTION = 138 "android.net.conn.INET_CONDITION_ACTION"; 139 140 /** 141 * Broadcast Action: A tetherable connection has come or gone 142 * TODO - finish the doc 143 * @hide 144 */ 145 public static final String ACTION_TETHER_STATE_CHANGED = 146 "android.net.conn.TETHER_STATE_CHANGED"; 147 148 /** 149 * @hide 150 * gives a String[] 151 */ 152 public static final String EXTRA_AVAILABLE_TETHER = "availableArray"; 153 154 /** 155 * @hide 156 * gives a String[] 157 */ 158 public static final String EXTRA_ACTIVE_TETHER = "activeArray"; 159 160 /** 161 * @hide 162 * gives a String[] 163 */ 164 public static final String EXTRA_ERRORED_TETHER = "erroredArray"; 165 166 /** 167 * The Default Mobile data connection. When active, all data traffic 168 * will use this connection by default. Should not coexist with other 169 * default connections. 170 */ 171 public static final int TYPE_MOBILE = 0; 172 /** 173 * The Default WIFI data connection. When active, all data traffic 174 * will use this connection by default. Should not coexist with other 175 * default connections. 176 */ 177 public static final int TYPE_WIFI = 1; 178 /** 179 * An MMS-specific Mobile data connection. This connection may be the 180 * same as {@link #TYPE_MOBILE} but it may be different. This is used 181 * by applications needing to talk to the carrier's Multimedia Messaging 182 * Service servers. It may coexist with default data connections. 183 */ 184 public static final int TYPE_MOBILE_MMS = 2; 185 /** 186 * A SUPL-specific Mobile data connection. This connection may be the 187 * same as {@link #TYPE_MOBILE} but it may be different. This is used 188 * by applications needing to talk to the carrier's Secure User Plane 189 * Location servers for help locating the device. It may coexist with 190 * default data connections. 191 */ 192 public static final int TYPE_MOBILE_SUPL = 3; 193 /** 194 * A DUN-specific Mobile data connection. This connection may be the 195 * same as {@link #TYPE_MOBILE} but it may be different. This is used 196 * by applicaitons performing a Dial Up Networking bridge so that 197 * the carrier is aware of DUN traffic. It may coexist with default data 198 * connections. 199 */ 200 public static final int TYPE_MOBILE_DUN = 4; 201 /** 202 * A High Priority Mobile data connection. This connection is typically 203 * the same as {@link #TYPE_MOBILE} but the routing setup is different. 204 * Only requesting processes will have access to the Mobile DNS servers 205 * and only IP's explicitly requested via {@link #requestRouteToHost} 206 * will route over this interface if a default route exists. 207 */ 208 public static final int TYPE_MOBILE_HIPRI = 5; 209 /** 210 * The Default WiMAX data connection. When active, all data traffic 211 * will use this connection by default. Should not coexist with other 212 * default connections. 213 */ 214 public static final int TYPE_WIMAX = 6; 215 /** 216 * Bluetooth data connection. 217 * @hide 218 */ 219 public static final int TYPE_BLUETOOTH = 7; 220 /** {@hide} */ 221 public static final int TYPE_DUMMY = 8; 222 /** {@hide} */ 223 public static final int TYPE_ETHERNET = 9; 224 /** {@hide} TODO: Need to adjust this for WiMAX. */ 225 public static final int MAX_RADIO_TYPE = TYPE_WIFI; 226 /** {@hide} TODO: Need to adjust this for WiMAX. */ 227 public static final int MAX_NETWORK_TYPE = TYPE_MOBILE_HIPRI; 228 229 public static final int DEFAULT_NETWORK_PREFERENCE = TYPE_WIFI; 230 231 private IConnectivityManager mService; 232 233 static public boolean isNetworkTypeValid(int networkType) { 234 return networkType >= 0 && networkType <= MAX_NETWORK_TYPE; 235 } 236 237 public void setNetworkPreference(int preference) { 238 try { 239 mService.setNetworkPreference(preference); 240 } catch (RemoteException e) { 241 } 242 } 243 244 public int getNetworkPreference() { 245 try { 246 return mService.getNetworkPreference(); 247 } catch (RemoteException e) { 248 return -1; 249 } 250 } 251 252 public NetworkInfo getActiveNetworkInfo() { 253 try { 254 return mService.getActiveNetworkInfo(); 255 } catch (RemoteException e) { 256 return null; 257 } 258 } 259 260 public NetworkInfo getNetworkInfo(int networkType) { 261 try { 262 return mService.getNetworkInfo(networkType); 263 } catch (RemoteException e) { 264 return null; 265 } 266 } 267 268 public NetworkInfo[] getAllNetworkInfo() { 269 try { 270 return mService.getAllNetworkInfo(); 271 } catch (RemoteException e) { 272 return null; 273 } 274 } 275 276 /** {@hide} */ 277 public boolean setRadios(boolean turnOn) { 278 try { 279 return mService.setRadios(turnOn); 280 } catch (RemoteException e) { 281 return false; 282 } 283 } 284 285 /** {@hide} */ 286 public boolean setRadio(int networkType, boolean turnOn) { 287 try { 288 return mService.setRadio(networkType, turnOn); 289 } catch (RemoteException e) { 290 return false; 291 } 292 } 293 294 /** 295 * Tells the underlying networking system that the caller wants to 296 * begin using the named feature. The interpretation of {@code feature} 297 * is completely up to each networking implementation. 298 * @param networkType specifies which network the request pertains to 299 * @param feature the name of the feature to be used 300 * @return an integer value representing the outcome of the request. 301 * The interpretation of this value is specific to each networking 302 * implementation+feature combination, except that the value {@code -1} 303 * always indicates failure. 304 */ 305 public int startUsingNetworkFeature(int networkType, String feature) { 306 try { 307 return mService.startUsingNetworkFeature(networkType, feature, 308 new Binder()); 309 } catch (RemoteException e) { 310 return -1; 311 } 312 } 313 314 /** 315 * Tells the underlying networking system that the caller is finished 316 * using the named feature. The interpretation of {@code feature} 317 * is completely up to each networking implementation. 318 * @param networkType specifies which network the request pertains to 319 * @param feature the name of the feature that is no longer needed 320 * @return an integer value representing the outcome of the request. 321 * The interpretation of this value is specific to each networking 322 * implementation+feature combination, except that the value {@code -1} 323 * always indicates failure. 324 */ 325 public int stopUsingNetworkFeature(int networkType, String feature) { 326 try { 327 return mService.stopUsingNetworkFeature(networkType, feature); 328 } catch (RemoteException e) { 329 return -1; 330 } 331 } 332 333 /** 334 * Ensure that a network route exists to deliver traffic to the specified 335 * host via the specified network interface. An attempt to add a route that 336 * already exists is ignored, but treated as successful. 337 * @param networkType the type of the network over which traffic to the specified 338 * host is to be routed 339 * @param hostAddress the IP address of the host to which the route is desired 340 * @return {@code true} on success, {@code false} on failure 341 */ 342 public boolean requestRouteToHost(int networkType, int hostAddress) { 343 InetAddress inetAddress = NetworkUtils.intToInetAddress(hostAddress); 344 345 if (inetAddress == null) { 346 return false; 347 } 348 349 return requestRouteToHostAddress(networkType, inetAddress); 350 } 351 352 /** 353 * Ensure that a network route exists to deliver traffic to the specified 354 * host via the specified network interface. An attempt to add a route that 355 * already exists is ignored, but treated as successful. 356 * @param networkType the type of the network over which traffic to the specified 357 * host is to be routed 358 * @param hostAddress the IP address of the host to which the route is desired 359 * @return {@code true} on success, {@code false} on failure 360 * @hide 361 */ 362 public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) { 363 byte[] address = hostAddress.getAddress(); 364 try { 365 return mService.requestRouteToHostAddress(networkType, address); 366 } catch (RemoteException e) { 367 return false; 368 } 369 } 370 371 /** 372 * Returns the value of the setting for background data usage. If false, 373 * applications should not use the network if the application is not in the 374 * foreground. Developers should respect this setting, and check the value 375 * of this before performing any background data operations. 376 * <p> 377 * All applications that have background services that use the network 378 * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}. 379 * 380 * @return Whether background data usage is allowed. 381 */ 382 public boolean getBackgroundDataSetting() { 383 try { 384 return mService.getBackgroundDataSetting(); 385 } catch (RemoteException e) { 386 // Err on the side of safety 387 return false; 388 } 389 } 390 391 /** 392 * Sets the value of the setting for background data usage. 393 * 394 * @param allowBackgroundData Whether an application should use data while 395 * it is in the background. 396 * 397 * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING 398 * @see #getBackgroundDataSetting() 399 * @hide 400 */ 401 public void setBackgroundDataSetting(boolean allowBackgroundData) { 402 try { 403 mService.setBackgroundDataSetting(allowBackgroundData); 404 } catch (RemoteException e) { 405 } 406 } 407 408 /** 409 * Gets the value of the setting for enabling Mobile data. 410 * 411 * @return Whether mobile data is enabled. 412 * @hide 413 */ 414 public boolean getMobileDataEnabled() { 415 try { 416 return mService.getMobileDataEnabled(); 417 } catch (RemoteException e) { 418 return true; 419 } 420 } 421 422 /** 423 * Sets the persisted value for enabling/disabling Mobile data. 424 * 425 * @param enabled Whether the mobile data connection should be 426 * used or not. 427 * @hide 428 */ 429 public void setMobileDataEnabled(boolean enabled) { 430 try { 431 mService.setMobileDataEnabled(enabled); 432 } catch (RemoteException e) { 433 } 434 } 435 436 /** 437 * Don't allow use of default constructor. 438 */ 439 @SuppressWarnings({"UnusedDeclaration"}) 440 private ConnectivityManager() { 441 } 442 443 /** 444 * {@hide} 445 */ 446 public ConnectivityManager(IConnectivityManager service) { 447 if (service == null) { 448 throw new IllegalArgumentException( 449 "ConnectivityManager() cannot be constructed with null service"); 450 } 451 mService = service; 452 } 453 454 /** 455 * {@hide} 456 */ 457 public String[] getTetherableIfaces() { 458 try { 459 return mService.getTetherableIfaces(); 460 } catch (RemoteException e) { 461 return new String[0]; 462 } 463 } 464 465 /** 466 * {@hide} 467 */ 468 public String[] getTetheredIfaces() { 469 try { 470 return mService.getTetheredIfaces(); 471 } catch (RemoteException e) { 472 return new String[0]; 473 } 474 } 475 476 /** 477 * {@hide} 478 */ 479 public String[] getTetheringErroredIfaces() { 480 try { 481 return mService.getTetheringErroredIfaces(); 482 } catch (RemoteException e) { 483 return new String[0]; 484 } 485 } 486 487 /** 488 * @return error A TETHER_ERROR value indicating success or failure type 489 * {@hide} 490 */ 491 public int tether(String iface) { 492 try { 493 return mService.tether(iface); 494 } catch (RemoteException e) { 495 return TETHER_ERROR_SERVICE_UNAVAIL; 496 } 497 } 498 499 /** 500 * @return error A TETHER_ERROR value indicating success or failure type 501 * {@hide} 502 */ 503 public int untether(String iface) { 504 try { 505 return mService.untether(iface); 506 } catch (RemoteException e) { 507 return TETHER_ERROR_SERVICE_UNAVAIL; 508 } 509 } 510 511 /** 512 * {@hide} 513 */ 514 public boolean isTetheringSupported() { 515 try { 516 return mService.isTetheringSupported(); 517 } catch (RemoteException e) { 518 return false; 519 } 520 } 521 522 /** 523 * {@hide} 524 */ 525 public String[] getTetherableUsbRegexs() { 526 try { 527 return mService.getTetherableUsbRegexs(); 528 } catch (RemoteException e) { 529 return new String[0]; 530 } 531 } 532 533 /** 534 * {@hide} 535 */ 536 public String[] getTetherableWifiRegexs() { 537 try { 538 return mService.getTetherableWifiRegexs(); 539 } catch (RemoteException e) { 540 return new String[0]; 541 } 542 } 543 544 /** {@hide} */ 545 public static final int TETHER_ERROR_NO_ERROR = 0; 546 /** {@hide} */ 547 public static final int TETHER_ERROR_UNKNOWN_IFACE = 1; 548 /** {@hide} */ 549 public static final int TETHER_ERROR_SERVICE_UNAVAIL = 2; 550 /** {@hide} */ 551 public static final int TETHER_ERROR_UNSUPPORTED = 3; 552 /** {@hide} */ 553 public static final int TETHER_ERROR_UNAVAIL_IFACE = 4; 554 /** {@hide} */ 555 public static final int TETHER_ERROR_MASTER_ERROR = 5; 556 /** {@hide} */ 557 public static final int TETHER_ERROR_TETHER_IFACE_ERROR = 6; 558 /** {@hide} */ 559 public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR = 7; 560 /** {@hide} */ 561 public static final int TETHER_ERROR_ENABLE_NAT_ERROR = 8; 562 /** {@hide} */ 563 public static final int TETHER_ERROR_DISABLE_NAT_ERROR = 9; 564 /** {@hide} */ 565 public static final int TETHER_ERROR_IFACE_CFG_ERROR = 10; 566 567 /** 568 * @param iface The name of the interface we're interested in 569 * @return error The error code of the last error tethering or untethering the named 570 * interface 571 * {@hide} 572 */ 573 public int getLastTetherError(String iface) { 574 try { 575 return mService.getLastTetherError(iface); 576 } catch (RemoteException e) { 577 return TETHER_ERROR_SERVICE_UNAVAIL; 578 } 579 } 580 581 /** 582 * @param networkType The type of network you want to report on 583 * @param percentage The quality of the connection 0 is bad, 100 is good 584 * {@hide} 585 */ 586 public void reportInetCondition(int networkType, int percentage) { 587 try { 588 mService.reportInetCondition(networkType, percentage); 589 } catch (RemoteException e) { 590 } 591 } 592} 593