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