ConnectivityManager.java revision 434203a277cd2f237a71508a3d5a7d1602126cd5
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 /** {@hide} TODO: Need to adjust this for WiMAX. */ 216 public static final int MAX_RADIO_TYPE = TYPE_WIFI; 217 /** {@hide} TODO: Need to adjust this for WiMAX. */ 218 public static final int MAX_NETWORK_TYPE = TYPE_MOBILE_HIPRI; 219 220 public static final int DEFAULT_NETWORK_PREFERENCE = TYPE_WIFI; 221 222 private IConnectivityManager mService; 223 224 static public boolean isNetworkTypeValid(int networkType) { 225 return networkType >= 0 && networkType <= MAX_NETWORK_TYPE; 226 } 227 228 public void setNetworkPreference(int preference) { 229 try { 230 mService.setNetworkPreference(preference); 231 } catch (RemoteException e) { 232 } 233 } 234 235 public int getNetworkPreference() { 236 try { 237 return mService.getNetworkPreference(); 238 } catch (RemoteException e) { 239 return -1; 240 } 241 } 242 243 public NetworkInfo getActiveNetworkInfo() { 244 try { 245 return mService.getActiveNetworkInfo(); 246 } catch (RemoteException e) { 247 return null; 248 } 249 } 250 251 public NetworkInfo getNetworkInfo(int networkType) { 252 try { 253 return mService.getNetworkInfo(networkType); 254 } catch (RemoteException e) { 255 return null; 256 } 257 } 258 259 public NetworkInfo[] getAllNetworkInfo() { 260 try { 261 return mService.getAllNetworkInfo(); 262 } catch (RemoteException e) { 263 return null; 264 } 265 } 266 267 /** @hide */ 268 public LinkProperties getActiveLinkProperties() { 269 try { 270 return mService.getActiveLinkProperties(); 271 } catch (RemoteException e) { 272 return null; 273 } 274 } 275 276 /** @hide */ 277 public LinkProperties getLinkProperties(int networkType) { 278 try { 279 return mService.getLinkProperties(networkType); 280 } catch (RemoteException e) { 281 return null; 282 } 283 } 284 285 /** {@hide} */ 286 public boolean setRadios(boolean turnOn) { 287 try { 288 return mService.setRadios(turnOn); 289 } catch (RemoteException e) { 290 return false; 291 } 292 } 293 294 /** {@hide} */ 295 public boolean setRadio(int networkType, boolean turnOn) { 296 try { 297 return mService.setRadio(networkType, turnOn); 298 } catch (RemoteException e) { 299 return false; 300 } 301 } 302 303 /** 304 * Tells the underlying networking system that the caller wants to 305 * begin using the named feature. The interpretation of {@code feature} 306 * is completely up to each networking implementation. 307 * @param networkType specifies which network the request pertains to 308 * @param feature the name of the feature to be used 309 * @return an integer value representing the outcome of the request. 310 * The interpretation of this value is specific to each networking 311 * implementation+feature combination, except that the value {@code -1} 312 * always indicates failure. 313 */ 314 public int startUsingNetworkFeature(int networkType, String feature) { 315 try { 316 return mService.startUsingNetworkFeature(networkType, feature, 317 new Binder()); 318 } catch (RemoteException e) { 319 return -1; 320 } 321 } 322 323 /** 324 * Tells the underlying networking system that the caller is finished 325 * using the named feature. The interpretation of {@code feature} 326 * is completely up to each networking implementation. 327 * @param networkType specifies which network the request pertains to 328 * @param feature the name of the feature that is no longer needed 329 * @return an integer value representing the outcome of the request. 330 * The interpretation of this value is specific to each networking 331 * implementation+feature combination, except that the value {@code -1} 332 * always indicates failure. 333 */ 334 public int stopUsingNetworkFeature(int networkType, String feature) { 335 try { 336 return mService.stopUsingNetworkFeature(networkType, feature); 337 } catch (RemoteException e) { 338 return -1; 339 } 340 } 341 342 /** 343 * Ensure that a network route exists to deliver traffic to the specified 344 * host via the specified network interface. An attempt to add a route that 345 * already exists is ignored, but treated as successful. 346 * @param networkType the type of the network over which traffic to the specified 347 * host is to be routed 348 * @param hostAddress the IP address of the host to which the route is desired 349 * @return {@code true} on success, {@code false} on failure 350 */ 351 public boolean requestRouteToHost(int networkType, int hostAddress) { 352 InetAddress inetAddress = NetworkUtils.intToInetAddress(hostAddress); 353 354 if (inetAddress == null) { 355 return false; 356 } 357 358 return requestRouteToHostAddress(networkType, inetAddress); 359 } 360 361 /** 362 * Ensure that a network route exists to deliver traffic to the specified 363 * host via the specified network interface. An attempt to add a route that 364 * already exists is ignored, but treated as successful. 365 * @param networkType the type of the network over which traffic to the specified 366 * host is to be routed 367 * @param hostAddress the IP address of the host to which the route is desired 368 * @return {@code true} on success, {@code false} on failure 369 * @hide 370 */ 371 public boolean requestRouteToHostAddress(int networkType, InetAddress hostAddress) { 372 byte[] address = hostAddress.getAddress(); 373 try { 374 return mService.requestRouteToHostAddress(networkType, address); 375 } catch (RemoteException e) { 376 return false; 377 } 378 } 379 380 /** 381 * Returns the value of the setting for background data usage. If false, 382 * applications should not use the network if the application is not in the 383 * foreground. Developers should respect this setting, and check the value 384 * of this before performing any background data operations. 385 * <p> 386 * All applications that have background services that use the network 387 * should listen to {@link #ACTION_BACKGROUND_DATA_SETTING_CHANGED}. 388 * 389 * @return Whether background data usage is allowed. 390 */ 391 public boolean getBackgroundDataSetting() { 392 try { 393 return mService.getBackgroundDataSetting(); 394 } catch (RemoteException e) { 395 // Err on the side of safety 396 return false; 397 } 398 } 399 400 /** 401 * Sets the value of the setting for background data usage. 402 * 403 * @param allowBackgroundData Whether an application should use data while 404 * it is in the background. 405 * 406 * @attr ref android.Manifest.permission#CHANGE_BACKGROUND_DATA_SETTING 407 * @see #getBackgroundDataSetting() 408 * @hide 409 */ 410 public void setBackgroundDataSetting(boolean allowBackgroundData) { 411 try { 412 mService.setBackgroundDataSetting(allowBackgroundData); 413 } catch (RemoteException e) { 414 } 415 } 416 417 /** 418 * Gets the value of the setting for enabling Mobile data. 419 * 420 * @return Whether mobile data is enabled. 421 * @hide 422 */ 423 public boolean getMobileDataEnabled() { 424 try { 425 return mService.getMobileDataEnabled(); 426 } catch (RemoteException e) { 427 return true; 428 } 429 } 430 431 /** 432 * Sets the persisted value for enabling/disabling Mobile data. 433 * 434 * @param enabled Whether the mobile data connection should be 435 * used or not. 436 * @hide 437 */ 438 public void setMobileDataEnabled(boolean enabled) { 439 try { 440 mService.setMobileDataEnabled(enabled); 441 } catch (RemoteException e) { 442 } 443 } 444 445 /** 446 * Don't allow use of default constructor. 447 */ 448 @SuppressWarnings({"UnusedDeclaration"}) 449 private ConnectivityManager() { 450 } 451 452 /** 453 * {@hide} 454 */ 455 public ConnectivityManager(IConnectivityManager service) { 456 if (service == null) { 457 throw new IllegalArgumentException( 458 "ConnectivityManager() cannot be constructed with null service"); 459 } 460 mService = service; 461 } 462 463 /** 464 * {@hide} 465 */ 466 public String[] getTetherableIfaces() { 467 try { 468 return mService.getTetherableIfaces(); 469 } catch (RemoteException e) { 470 return new String[0]; 471 } 472 } 473 474 /** 475 * {@hide} 476 */ 477 public String[] getTetheredIfaces() { 478 try { 479 return mService.getTetheredIfaces(); 480 } catch (RemoteException e) { 481 return new String[0]; 482 } 483 } 484 485 /** 486 * {@hide} 487 */ 488 public String[] getTetheringErroredIfaces() { 489 try { 490 return mService.getTetheringErroredIfaces(); 491 } catch (RemoteException e) { 492 return new String[0]; 493 } 494 } 495 496 /** 497 * @return error A TETHER_ERROR value indicating success or failure type 498 * {@hide} 499 */ 500 public int tether(String iface) { 501 try { 502 return mService.tether(iface); 503 } catch (RemoteException e) { 504 return TETHER_ERROR_SERVICE_UNAVAIL; 505 } 506 } 507 508 /** 509 * @return error A TETHER_ERROR value indicating success or failure type 510 * {@hide} 511 */ 512 public int untether(String iface) { 513 try { 514 return mService.untether(iface); 515 } catch (RemoteException e) { 516 return TETHER_ERROR_SERVICE_UNAVAIL; 517 } 518 } 519 520 /** 521 * {@hide} 522 */ 523 public boolean isTetheringSupported() { 524 try { 525 return mService.isTetheringSupported(); 526 } catch (RemoteException e) { 527 return false; 528 } 529 } 530 531 /** 532 * {@hide} 533 */ 534 public String[] getTetherableUsbRegexs() { 535 try { 536 return mService.getTetherableUsbRegexs(); 537 } catch (RemoteException e) { 538 return new String[0]; 539 } 540 } 541 542 /** 543 * {@hide} 544 */ 545 public String[] getTetherableWifiRegexs() { 546 try { 547 return mService.getTetherableWifiRegexs(); 548 } catch (RemoteException e) { 549 return new String[0]; 550 } 551 } 552 553 /** 554 * {@hide} 555 */ 556 public String[] getTetherableBluetoothRegexs() { 557 try { 558 return mService.getTetherableBluetoothRegexs(); 559 } catch (RemoteException e) { 560 return new String[0]; 561 } 562 } 563 564 /** {@hide} */ 565 public static final int TETHER_ERROR_NO_ERROR = 0; 566 /** {@hide} */ 567 public static final int TETHER_ERROR_UNKNOWN_IFACE = 1; 568 /** {@hide} */ 569 public static final int TETHER_ERROR_SERVICE_UNAVAIL = 2; 570 /** {@hide} */ 571 public static final int TETHER_ERROR_UNSUPPORTED = 3; 572 /** {@hide} */ 573 public static final int TETHER_ERROR_UNAVAIL_IFACE = 4; 574 /** {@hide} */ 575 public static final int TETHER_ERROR_MASTER_ERROR = 5; 576 /** {@hide} */ 577 public static final int TETHER_ERROR_TETHER_IFACE_ERROR = 6; 578 /** {@hide} */ 579 public static final int TETHER_ERROR_UNTETHER_IFACE_ERROR = 7; 580 /** {@hide} */ 581 public static final int TETHER_ERROR_ENABLE_NAT_ERROR = 8; 582 /** {@hide} */ 583 public static final int TETHER_ERROR_DISABLE_NAT_ERROR = 9; 584 /** {@hide} */ 585 public static final int TETHER_ERROR_IFACE_CFG_ERROR = 10; 586 587 /** 588 * @param iface The name of the interface we're interested in 589 * @return error The error code of the last error tethering or untethering the named 590 * interface 591 * {@hide} 592 */ 593 public int getLastTetherError(String iface) { 594 try { 595 return mService.getLastTetherError(iface); 596 } catch (RemoteException e) { 597 return TETHER_ERROR_SERVICE_UNAVAIL; 598 } 599 } 600 601 /** 602 * Ensure the device stays awake until we connect with the next network 603 * @param forWhome The name of the network going down for logging purposes 604 * @return {@code true} on success, {@code false} on failure 605 * {@hide} 606 */ 607 public boolean requestNetworkTransitionWakelock(String forWhom) { 608 try { 609 mService.requestNetworkTransitionWakelock(forWhom); 610 return true; 611 } catch (RemoteException e) { 612 return false; 613 } 614 } 615 616 /** 617 * @param networkType The type of network you want to report on 618 * @param percentage The quality of the connection 0 is bad, 100 is good 619 * {@hide} 620 */ 621 public void reportInetCondition(int networkType, int percentage) { 622 try { 623 mService.reportInetCondition(networkType, percentage); 624 } catch (RemoteException e) { 625 } 626 } 627 628 /** 629 * @param proxyProperties The definition for the new global http proxy 630 * {@hide} 631 */ 632 public void setGlobalProxy(ProxyProperties p) { 633 try { 634 mService.setGlobalProxy(p); 635 } catch (RemoteException e) { 636 } 637 } 638 639 /** 640 * @return proxyProperties for the current global proxy 641 * {@hide} 642 */ 643 public ProxyProperties getGlobalProxy() { 644 try { 645 return mService.getGlobalProxy(); 646 } catch (RemoteException e) { 647 return null; 648 } 649 } 650 651 /** 652 * @return proxyProperties for the current proxy (global if set, network specific if not) 653 * {@hide} 654 */ 655 public ProxyProperties getProxy() { 656 try { 657 return mService.getProxy(); 658 } catch (RemoteException e) { 659 return null; 660 } 661 } 662} 663