WifiManager.java revision 10652a95b16909acf26f31cdafc0c6aa09212f26
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.wifi; 18 19import android.annotation.SdkConstant; 20import android.annotation.SdkConstant.SdkConstantType; 21import android.content.Context; 22import android.net.DhcpInfo; 23import android.os.Binder; 24import android.os.IBinder; 25import android.os.Handler; 26import android.os.HandlerThread; 27import android.os.Looper; 28import android.os.Message; 29import android.os.RemoteException; 30import android.os.WorkSource; 31import android.os.Messenger; 32import android.util.Log; 33import android.util.SparseArray; 34 35import java.net.InetAddress; 36import java.util.concurrent.CountDownLatch; 37 38import com.android.internal.R; 39import com.android.internal.util.AsyncChannel; 40import com.android.internal.util.Protocol; 41 42import java.util.List; 43 44/** 45 * This class provides the primary API for managing all aspects of Wi-Fi 46 * connectivity. Get an instance of this class by calling 47 * {@link android.content.Context#getSystemService(String) Context.getSystemService(Context.WIFI_SERVICE)}. 48 49 * It deals with several categories of items: 50 * <ul> 51 * <li>The list of configured networks. The list can be viewed and updated, 52 * and attributes of individual entries can be modified.</li> 53 * <li>The currently active Wi-Fi network, if any. Connectivity can be 54 * established or torn down, and dynamic information about the state of 55 * the network can be queried.</li> 56 * <li>Results of access point scans, containing enough information to 57 * make decisions about what access point to connect to.</li> 58 * <li>It defines the names of various Intent actions that are broadcast 59 * upon any sort of change in Wi-Fi state. 60 * </ul> 61 * This is the API to use when performing Wi-Fi specific operations. To 62 * perform operations that pertain to network connectivity at an abstract 63 * level, use {@link android.net.ConnectivityManager}. 64 */ 65public class WifiManager { 66 67 private static final String TAG = "WifiManager"; 68 // Supplicant error codes: 69 /** 70 * The error code if there was a problem authenticating. 71 */ 72 public static final int ERROR_AUTHENTICATING = 1; 73 74 /** 75 * Broadcast intent action indicating whether Wi-Fi scanning is allowed currently 76 * @hide 77 */ 78 public static final String WIFI_SCAN_AVAILABLE = "wifi_scan_available"; 79 80 /** 81 * Extra int indicating scan availability, WIFI_STATE_ENABLED and WIFI_STATE_DISABLED 82 * @hide 83 */ 84 public static final String EXTRA_SCAN_AVAILABLE = "scan_enabled"; 85 86 /** 87 * Broadcast intent action indicating that Wi-Fi has been enabled, disabled, 88 * enabling, disabling, or unknown. One extra provides this state as an int. 89 * Another extra provides the previous state, if available. 90 * 91 * @see #EXTRA_WIFI_STATE 92 * @see #EXTRA_PREVIOUS_WIFI_STATE 93 */ 94 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 95 public static final String WIFI_STATE_CHANGED_ACTION = 96 "android.net.wifi.WIFI_STATE_CHANGED"; 97 /** 98 * The lookup key for an int that indicates whether Wi-Fi is enabled, 99 * disabled, enabling, disabling, or unknown. Retrieve it with 100 * {@link android.content.Intent#getIntExtra(String,int)}. 101 * 102 * @see #WIFI_STATE_DISABLED 103 * @see #WIFI_STATE_DISABLING 104 * @see #WIFI_STATE_ENABLED 105 * @see #WIFI_STATE_ENABLING 106 * @see #WIFI_STATE_UNKNOWN 107 */ 108 public static final String EXTRA_WIFI_STATE = "wifi_state"; 109 /** 110 * The previous Wi-Fi state. 111 * 112 * @see #EXTRA_WIFI_STATE 113 */ 114 public static final String EXTRA_PREVIOUS_WIFI_STATE = "previous_wifi_state"; 115 116 /** 117 * Wi-Fi is currently being disabled. The state will change to {@link #WIFI_STATE_DISABLED} if 118 * it finishes successfully. 119 * 120 * @see #WIFI_STATE_CHANGED_ACTION 121 * @see #getWifiState() 122 */ 123 public static final int WIFI_STATE_DISABLING = 0; 124 /** 125 * Wi-Fi is disabled. 126 * 127 * @see #WIFI_STATE_CHANGED_ACTION 128 * @see #getWifiState() 129 */ 130 public static final int WIFI_STATE_DISABLED = 1; 131 /** 132 * Wi-Fi is currently being enabled. The state will change to {@link #WIFI_STATE_ENABLED} if 133 * it finishes successfully. 134 * 135 * @see #WIFI_STATE_CHANGED_ACTION 136 * @see #getWifiState() 137 */ 138 public static final int WIFI_STATE_ENABLING = 2; 139 /** 140 * Wi-Fi is enabled. 141 * 142 * @see #WIFI_STATE_CHANGED_ACTION 143 * @see #getWifiState() 144 */ 145 public static final int WIFI_STATE_ENABLED = 3; 146 /** 147 * Wi-Fi is in an unknown state. This state will occur when an error happens while enabling 148 * or disabling. 149 * 150 * @see #WIFI_STATE_CHANGED_ACTION 151 * @see #getWifiState() 152 */ 153 public static final int WIFI_STATE_UNKNOWN = 4; 154 155 /** 156 * Broadcast intent action indicating that Wi-Fi AP has been enabled, disabled, 157 * enabling, disabling, or failed. 158 * 159 * @hide 160 */ 161 public static final String WIFI_AP_STATE_CHANGED_ACTION = 162 "android.net.wifi.WIFI_AP_STATE_CHANGED"; 163 164 /** 165 * The lookup key for an int that indicates whether Wi-Fi AP is enabled, 166 * disabled, enabling, disabling, or failed. Retrieve it with 167 * {@link android.content.Intent#getIntExtra(String,int)}. 168 * 169 * @see #WIFI_AP_STATE_DISABLED 170 * @see #WIFI_AP_STATE_DISABLING 171 * @see #WIFI_AP_STATE_ENABLED 172 * @see #WIFI_AP_STATE_ENABLING 173 * @see #WIFI_AP_STATE_FAILED 174 * 175 * @hide 176 */ 177 public static final String EXTRA_WIFI_AP_STATE = "wifi_state"; 178 /** 179 * The previous Wi-Fi state. 180 * 181 * @see #EXTRA_WIFI_AP_STATE 182 * 183 * @hide 184 */ 185 public static final String EXTRA_PREVIOUS_WIFI_AP_STATE = "previous_wifi_state"; 186 /** 187 * Wi-Fi AP is currently being disabled. The state will change to 188 * {@link #WIFI_AP_STATE_DISABLED} if it finishes successfully. 189 * 190 * @see #WIFI_AP_STATE_CHANGED_ACTION 191 * @see #getWifiApState() 192 * 193 * @hide 194 */ 195 public static final int WIFI_AP_STATE_DISABLING = 10; 196 /** 197 * Wi-Fi AP is disabled. 198 * 199 * @see #WIFI_AP_STATE_CHANGED_ACTION 200 * @see #getWifiState() 201 * 202 * @hide 203 */ 204 public static final int WIFI_AP_STATE_DISABLED = 11; 205 /** 206 * Wi-Fi AP is currently being enabled. The state will change to 207 * {@link #WIFI_AP_STATE_ENABLED} if it finishes successfully. 208 * 209 * @see #WIFI_AP_STATE_CHANGED_ACTION 210 * @see #getWifiApState() 211 * 212 * @hide 213 */ 214 public static final int WIFI_AP_STATE_ENABLING = 12; 215 /** 216 * Wi-Fi AP is enabled. 217 * 218 * @see #WIFI_AP_STATE_CHANGED_ACTION 219 * @see #getWifiApState() 220 * 221 * @hide 222 */ 223 public static final int WIFI_AP_STATE_ENABLED = 13; 224 /** 225 * Wi-Fi AP is in a failed state. This state will occur when an error occurs during 226 * enabling or disabling 227 * 228 * @see #WIFI_AP_STATE_CHANGED_ACTION 229 * @see #getWifiApState() 230 * 231 * @hide 232 */ 233 public static final int WIFI_AP_STATE_FAILED = 14; 234 235 /** 236 * Broadcast intent action indicating that a connection to the supplicant has 237 * been established (and it is now possible 238 * to perform Wi-Fi operations) or the connection to the supplicant has been 239 * lost. One extra provides the connection state as a boolean, where {@code true} 240 * means CONNECTED. 241 * @see #EXTRA_SUPPLICANT_CONNECTED 242 */ 243 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 244 public static final String SUPPLICANT_CONNECTION_CHANGE_ACTION = 245 "android.net.wifi.supplicant.CONNECTION_CHANGE"; 246 /** 247 * The lookup key for a boolean that indicates whether a connection to 248 * the supplicant daemon has been gained or lost. {@code true} means 249 * a connection now exists. 250 * Retrieve it with {@link android.content.Intent#getBooleanExtra(String,boolean)}. 251 */ 252 public static final String EXTRA_SUPPLICANT_CONNECTED = "connected"; 253 /** 254 * Broadcast intent action indicating that the state of Wi-Fi connectivity 255 * has changed. One extra provides the new state 256 * in the form of a {@link android.net.NetworkInfo} object. If the new 257 * state is CONNECTED, additional extras may provide the BSSID and WifiInfo of 258 * the access point. 259 * as a {@code String}. 260 * @see #EXTRA_NETWORK_INFO 261 * @see #EXTRA_BSSID 262 * @see #EXTRA_WIFI_INFO 263 */ 264 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 265 public static final String NETWORK_STATE_CHANGED_ACTION = "android.net.wifi.STATE_CHANGE"; 266 /** 267 * The lookup key for a {@link android.net.NetworkInfo} object associated with the 268 * Wi-Fi network. Retrieve with 269 * {@link android.content.Intent#getParcelableExtra(String)}. 270 */ 271 public static final String EXTRA_NETWORK_INFO = "networkInfo"; 272 /** 273 * The lookup key for a String giving the BSSID of the access point to which 274 * we are connected. Only present when the new state is CONNECTED. 275 * Retrieve with 276 * {@link android.content.Intent#getStringExtra(String)}. 277 */ 278 public static final String EXTRA_BSSID = "bssid"; 279 /** 280 * The lookup key for a {@link android.net.wifi.WifiInfo} object giving the 281 * information about the access point to which we are connected. Only present 282 * when the new state is CONNECTED. Retrieve with 283 * {@link android.content.Intent#getParcelableExtra(String)}. 284 */ 285 public static final String EXTRA_WIFI_INFO = "wifiInfo"; 286 /** 287 * Broadcast intent action indicating that the state of establishing a connection to 288 * an access point has changed.One extra provides the new 289 * {@link SupplicantState}. Note that the supplicant state is Wi-Fi specific, and 290 * is not generally the most useful thing to look at if you are just interested in 291 * the overall state of connectivity. 292 * @see #EXTRA_NEW_STATE 293 * @see #EXTRA_SUPPLICANT_ERROR 294 */ 295 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 296 public static final String SUPPLICANT_STATE_CHANGED_ACTION = 297 "android.net.wifi.supplicant.STATE_CHANGE"; 298 /** 299 * The lookup key for a {@link SupplicantState} describing the new state 300 * Retrieve with 301 * {@link android.content.Intent#getParcelableExtra(String)}. 302 */ 303 public static final String EXTRA_NEW_STATE = "newState"; 304 305 /** 306 * The lookup key for a {@link SupplicantState} describing the supplicant 307 * error code if any 308 * Retrieve with 309 * {@link android.content.Intent#getIntExtra(String, int)}. 310 * @see #ERROR_AUTHENTICATING 311 */ 312 public static final String EXTRA_SUPPLICANT_ERROR = "supplicantError"; 313 314 /** 315 * Broadcast intent action indicating that the configured networks changed. 316 * This can be as a result of adding/updating/deleting a network. If 317 * {@link #EXTRA_MULTIPLE_NETWORKS_CHANGED} is set to true the new configuration 318 * can be retreived with the {@link #EXTRA_WIFI_CONFIGURATION} extra. If multiple 319 * Wi-Fi configurations changed, {@link #EXTRA_WIFI_CONFIGURATION} will not be present. 320 * @hide 321 */ 322 public static final String CONFIGURED_NETWORKS_CHANGED_ACTION = 323 "android.net.wifi.CONFIGURED_NETWORKS_CHANGE"; 324 /** 325 * The lookup key for a (@link android.net.wifi.WifiConfiguration} object representing 326 * the changed Wi-Fi configuration when the {@link #CONFIGURED_NETWORKS_CHANGED_ACTION} 327 * broadcast is sent. 328 * @hide 329 */ 330 public static final String EXTRA_WIFI_CONFIGURATION = "wifiConfiguration"; 331 /** 332 * Multiple network configurations have changed. 333 * @see #CONFIGURED_NETWORKS_CHANGED_ACTION 334 * 335 * @hide 336 */ 337 public static final String EXTRA_MULTIPLE_NETWORKS_CHANGED = "multipleChanges"; 338 /** 339 * The lookup key for an integer indicating the reason a Wi-Fi network configuration 340 * has changed. Only present if {@link #EXTRA_MULTIPLE_NETWORKS_CHANGED} is {@code false} 341 * @see #CONFIGURED_NETWORKS_CHANGED_ACTION 342 * @hide 343 */ 344 public static final String EXTRA_CHANGE_REASON = "changeReason"; 345 /** 346 * The configuration is new and was added. 347 * @hide 348 */ 349 public static final int CHANGE_REASON_ADDED = 0; 350 /** 351 * The configuration was removed and is no longer present in the system's list of 352 * configured networks. 353 * @hide 354 */ 355 public static final int CHANGE_REASON_REMOVED = 1; 356 /** 357 * The configuration has changed as a result of explicit action or because the system 358 * took an automated action such as disabling a malfunctioning configuration. 359 * @hide 360 */ 361 public static final int CHANGE_REASON_CONFIG_CHANGE = 2; 362 /** 363 * An access point scan has completed, and results are available from the supplicant. 364 * Call {@link #getScanResults()} to obtain the results. 365 */ 366 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 367 public static final String SCAN_RESULTS_AVAILABLE_ACTION = "android.net.wifi.SCAN_RESULTS"; 368 /** 369 * A batch of access point scans has been completed and the results areavailable. 370 * Call {@link #getBatchedScanResults()} to obtain the results. 371 * @hide pending review 372 */ 373 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 374 public static final String BATCHED_SCAN_RESULTS_AVAILABLE_ACTION = 375 "android.net.wifi.BATCHED_RESULTS"; 376 /** 377 * The RSSI (signal strength) has changed. 378 * @see #EXTRA_NEW_RSSI 379 */ 380 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 381 public static final String RSSI_CHANGED_ACTION = "android.net.wifi.RSSI_CHANGED"; 382 /** 383 * The lookup key for an {@code int} giving the new RSSI in dBm. 384 */ 385 public static final String EXTRA_NEW_RSSI = "newRssi"; 386 387 /** 388 * Broadcast intent action indicating that the link configuration 389 * changed on wifi. 390 * @hide 391 */ 392 public static final String LINK_CONFIGURATION_CHANGED_ACTION = 393 "android.net.wifi.LINK_CONFIGURATION_CHANGED"; 394 395 /** 396 * The lookup key for a {@link android.net.LinkProperties} object associated with the 397 * Wi-Fi network. Retrieve with 398 * {@link android.content.Intent#getParcelableExtra(String)}. 399 * @hide 400 */ 401 public static final String EXTRA_LINK_PROPERTIES = "linkProperties"; 402 403 /** 404 * The lookup key for a {@link android.net.LinkCapabilities} object associated with the 405 * Wi-Fi network. Retrieve with 406 * {@link android.content.Intent#getParcelableExtra(String)}. 407 * @hide 408 */ 409 public static final String EXTRA_LINK_CAPABILITIES = "linkCapabilities"; 410 411 /** 412 * The network IDs of the configured networks could have changed. 413 */ 414 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION) 415 public static final String NETWORK_IDS_CHANGED_ACTION = "android.net.wifi.NETWORK_IDS_CHANGED"; 416 417 /** 418 * Activity Action: Show a system activity that allows the user to enable 419 * scans to be available even with Wi-Fi turned off. 420 * 421 * <p>Notification of the result of this activity is posted using the 422 * {@link android.app.Activity#onActivityResult} callback. The 423 * <code>resultCode</code> 424 * will be {@link android.app.Activity#RESULT_OK} if scan always mode has 425 * been turned on or {@link android.app.Activity#RESULT_CANCELED} if the user 426 * has rejected the request or an error has occurred. 427 */ 428 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 429 public static final String ACTION_REQUEST_SCAN_ALWAYS_AVAILABLE = 430 "android.net.wifi.action.REQUEST_SCAN_ALWAYS_AVAILABLE"; 431 432 /** 433 * Activity Action: Pick a Wi-Fi network to connect to. 434 * <p>Input: Nothing. 435 * <p>Output: Nothing. 436 */ 437 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 438 public static final String ACTION_PICK_WIFI_NETWORK = "android.net.wifi.PICK_WIFI_NETWORK"; 439 440 /** 441 * In this Wi-Fi lock mode, Wi-Fi will be kept active, 442 * and will behave normally, i.e., it will attempt to automatically 443 * establish a connection to a remembered access point that is 444 * within range, and will do periodic scans if there are remembered 445 * access points but none are in range. 446 */ 447 public static final int WIFI_MODE_FULL = 1; 448 /** 449 * In this Wi-Fi lock mode, Wi-Fi will be kept active, 450 * but the only operation that will be supported is initiation of 451 * scans, and the subsequent reporting of scan results. No attempts 452 * will be made to automatically connect to remembered access points, 453 * nor will periodic scans be automatically performed looking for 454 * remembered access points. Scans must be explicitly requested by 455 * an application in this mode. 456 */ 457 public static final int WIFI_MODE_SCAN_ONLY = 2; 458 /** 459 * In this Wi-Fi lock mode, Wi-Fi will be kept active as in mode 460 * {@link #WIFI_MODE_FULL} but it operates at high performance 461 * with minimum packet loss and low packet latency even when 462 * the device screen is off. This mode will consume more power 463 * and hence should be used only when there is a need for such 464 * an active connection. 465 * <p> 466 * An example use case is when a voice connection needs to be 467 * kept active even after the device screen goes off. Holding the 468 * regular {@link #WIFI_MODE_FULL} lock will keep the wifi 469 * connection active, but the connection can be lossy. 470 * Holding a {@link #WIFI_MODE_FULL_HIGH_PERF} lock for the 471 * duration of the voice call will improve the call quality. 472 * <p> 473 * When there is no support from the hardware, this lock mode 474 * will have the same behavior as {@link #WIFI_MODE_FULL} 475 */ 476 public static final int WIFI_MODE_FULL_HIGH_PERF = 3; 477 478 /** Anything worse than or equal to this will show 0 bars. */ 479 private static final int MIN_RSSI = -100; 480 481 /** Anything better than or equal to this will show the max bars. */ 482 private static final int MAX_RSSI = -55; 483 484 /** 485 * Number of RSSI levels used in the framework to initiate 486 * {@link #RSSI_CHANGED_ACTION} broadcast 487 * @hide 488 */ 489 public static final int RSSI_LEVELS = 5; 490 491 /** 492 * Auto settings in the driver. The driver could choose to operate on both 493 * 2.4 GHz and 5 GHz or make a dynamic decision on selecting the band. 494 * @hide 495 */ 496 public static final int WIFI_FREQUENCY_BAND_AUTO = 0; 497 498 /** 499 * Operation on 5 GHz alone 500 * @hide 501 */ 502 public static final int WIFI_FREQUENCY_BAND_5GHZ = 1; 503 504 /** 505 * Operation on 2.4 GHz alone 506 * @hide 507 */ 508 public static final int WIFI_FREQUENCY_BAND_2GHZ = 2; 509 510 /** List of asyncronous notifications 511 * @hide 512 */ 513 public static final int DATA_ACTIVITY_NOTIFICATION = 1; 514 515 //Lowest bit indicates data reception and the second lowest 516 //bit indicates data transmitted 517 /** @hide */ 518 public static final int DATA_ACTIVITY_NONE = 0x00; 519 /** @hide */ 520 public static final int DATA_ACTIVITY_IN = 0x01; 521 /** @hide */ 522 public static final int DATA_ACTIVITY_OUT = 0x02; 523 /** @hide */ 524 public static final int DATA_ACTIVITY_INOUT = 0x03; 525 526 /* Maximum number of active locks we allow. 527 * This limit was added to prevent apps from creating a ridiculous number 528 * of locks and crashing the system by overflowing the global ref table. 529 */ 530 private static final int MAX_ACTIVE_LOCKS = 50; 531 532 /* Number of currently active WifiLocks and MulticastLocks */ 533 private int mActiveLockCount; 534 535 private Context mContext; 536 IWifiManager mService; 537 538 private static final int INVALID_KEY = 0; 539 private static int sListenerKey = 1; 540 private static final SparseArray sListenerMap = new SparseArray(); 541 private static final Object sListenerMapLock = new Object(); 542 543 private static AsyncChannel sAsyncChannel; 544 private static CountDownLatch sConnected; 545 546 private static final Object sThreadRefLock = new Object(); 547 private static int sThreadRefCount; 548 private static HandlerThread sHandlerThread; 549 550 /** 551 * Create a new WifiManager instance. 552 * Applications will almost always want to use 553 * {@link android.content.Context#getSystemService Context.getSystemService()} to retrieve 554 * the standard {@link android.content.Context#WIFI_SERVICE Context.WIFI_SERVICE}. 555 * @param context the application context 556 * @param service the Binder interface 557 * @hide - hide this because it takes in a parameter of type IWifiManager, which 558 * is a system private class. 559 */ 560 public WifiManager(Context context, IWifiManager service) { 561 mContext = context; 562 mService = service; 563 init(); 564 } 565 566 /** 567 * Return a list of all the networks configured in the supplicant. 568 * Not all fields of WifiConfiguration are returned. Only the following 569 * fields are filled in: 570 * <ul> 571 * <li>networkId</li> 572 * <li>SSID</li> 573 * <li>BSSID</li> 574 * <li>priority</li> 575 * <li>allowedProtocols</li> 576 * <li>allowedKeyManagement</li> 577 * <li>allowedAuthAlgorithms</li> 578 * <li>allowedPairwiseCiphers</li> 579 * <li>allowedGroupCiphers</li> 580 * </ul> 581 * @return a list of network configurations in the form of a list 582 * of {@link WifiConfiguration} objects. Upon failure to fetch or 583 * when when Wi-Fi is turned off, it can be null. 584 */ 585 public List<WifiConfiguration> getConfiguredNetworks() { 586 try { 587 return mService.getConfiguredNetworks(); 588 } catch (RemoteException e) { 589 return null; 590 } 591 } 592 593 /** 594 * Add a new network description to the set of configured networks. 595 * The {@code networkId} field of the supplied configuration object 596 * is ignored. 597 * <p/> 598 * The new network will be marked DISABLED by default. To enable it, 599 * called {@link #enableNetwork}. 600 * 601 * @param config the set of variables that describe the configuration, 602 * contained in a {@link WifiConfiguration} object. 603 * @return the ID of the newly created network description. This is used in 604 * other operations to specified the network to be acted upon. 605 * Returns {@code -1} on failure. 606 */ 607 public int addNetwork(WifiConfiguration config) { 608 if (config == null) { 609 return -1; 610 } 611 config.networkId = -1; 612 return addOrUpdateNetwork(config); 613 } 614 615 /** 616 * Update the network description of an existing configured network. 617 * 618 * @param config the set of variables that describe the configuration, 619 * contained in a {@link WifiConfiguration} object. It may 620 * be sparse, so that only the items that are being changed 621 * are non-<code>null</code>. The {@code networkId} field 622 * must be set to the ID of the existing network being updated. 623 * @return Returns the {@code networkId} of the supplied 624 * {@code WifiConfiguration} on success. 625 * <br/> 626 * Returns {@code -1} on failure, including when the {@code networkId} 627 * field of the {@code WifiConfiguration} does not refer to an 628 * existing network. 629 */ 630 public int updateNetwork(WifiConfiguration config) { 631 if (config == null || config.networkId < 0) { 632 return -1; 633 } 634 return addOrUpdateNetwork(config); 635 } 636 637 /** 638 * Internal method for doing the RPC that creates a new network description 639 * or updates an existing one. 640 * 641 * @param config The possibly sparse object containing the variables that 642 * are to set or updated in the network description. 643 * @return the ID of the network on success, {@code -1} on failure. 644 */ 645 private int addOrUpdateNetwork(WifiConfiguration config) { 646 try { 647 return mService.addOrUpdateNetwork(config); 648 } catch (RemoteException e) { 649 return -1; 650 } 651 } 652 653 /** 654 * Remove the specified network from the list of configured networks. 655 * This may result in the asynchronous delivery of state change 656 * events. 657 * @param netId the integer that identifies the network configuration 658 * to the supplicant 659 * @return {@code true} if the operation succeeded 660 */ 661 public boolean removeNetwork(int netId) { 662 try { 663 return mService.removeNetwork(netId); 664 } catch (RemoteException e) { 665 return false; 666 } 667 } 668 669 /** 670 * Allow a previously configured network to be associated with. If 671 * <code>disableOthers</code> is true, then all other configured 672 * networks are disabled, and an attempt to connect to the selected 673 * network is initiated. This may result in the asynchronous delivery 674 * of state change events. 675 * @param netId the ID of the network in the list of configured networks 676 * @param disableOthers if true, disable all other networks. The way to 677 * select a particular network to connect to is specify {@code true} 678 * for this parameter. 679 * @return {@code true} if the operation succeeded 680 */ 681 public boolean enableNetwork(int netId, boolean disableOthers) { 682 try { 683 return mService.enableNetwork(netId, disableOthers); 684 } catch (RemoteException e) { 685 return false; 686 } 687 } 688 689 /** 690 * Disable a configured network. The specified network will not be 691 * a candidate for associating. This may result in the asynchronous 692 * delivery of state change events. 693 * @param netId the ID of the network as returned by {@link #addNetwork}. 694 * @return {@code true} if the operation succeeded 695 */ 696 public boolean disableNetwork(int netId) { 697 try { 698 return mService.disableNetwork(netId); 699 } catch (RemoteException e) { 700 return false; 701 } 702 } 703 704 /** 705 * Disassociate from the currently active access point. This may result 706 * in the asynchronous delivery of state change events. 707 * @return {@code true} if the operation succeeded 708 */ 709 public boolean disconnect() { 710 try { 711 mService.disconnect(); 712 return true; 713 } catch (RemoteException e) { 714 return false; 715 } 716 } 717 718 /** 719 * Reconnect to the currently active access point, if we are currently 720 * disconnected. This may result in the asynchronous delivery of state 721 * change events. 722 * @return {@code true} if the operation succeeded 723 */ 724 public boolean reconnect() { 725 try { 726 mService.reconnect(); 727 return true; 728 } catch (RemoteException e) { 729 return false; 730 } 731 } 732 733 /** 734 * Reconnect to the currently active access point, even if we are already 735 * connected. This may result in the asynchronous delivery of state 736 * change events. 737 * @return {@code true} if the operation succeeded 738 */ 739 public boolean reassociate() { 740 try { 741 mService.reassociate(); 742 return true; 743 } catch (RemoteException e) { 744 return false; 745 } 746 } 747 748 /** 749 * Check that the supplicant daemon is responding to requests. 750 * @return {@code true} if we were able to communicate with the supplicant and 751 * it returned the expected response to the PING message. 752 */ 753 public boolean pingSupplicant() { 754 if (mService == null) 755 return false; 756 try { 757 return mService.pingSupplicant(); 758 } catch (RemoteException e) { 759 return false; 760 } 761 } 762 763 /** 764 * Request a scan for access points. Returns immediately. The availability 765 * of the results is made known later by means of an asynchronous event sent 766 * on completion of the scan. 767 * @return {@code true} if the operation succeeded, i.e., the scan was initiated 768 */ 769 public boolean startScan() { 770 try { 771 final WorkSource workSource = null; 772 mService.startScan(workSource); 773 return true; 774 } catch (RemoteException e) { 775 return false; 776 } 777 } 778 779 /** @hide */ 780 public boolean startScan(WorkSource workSource) { 781 try { 782 mService.startScan(workSource); 783 return true; 784 } catch (RemoteException e) { 785 return false; 786 } 787 } 788 789 /** 790 * Request a batched scan for access points. To end your requested batched scan, 791 * call stopBatchedScan with the same Settings. 792 * 793 * If there are mulitple requests for batched scans, the more demanding settings will 794 * take precidence. 795 * 796 * @param requested {@link BatchedScanSettings} the scan settings requested. 797 * @return false on known error 798 * @hide 799 */ 800 public boolean requestBatchedScan(BatchedScanSettings requested) { 801 try { 802 return mService.requestBatchedScan(requested, new Binder()); 803 } catch (RemoteException e) { return false; } 804 } 805 806 /** 807 * Check if the Batched Scan feature is supported. 808 * 809 * @return false if not supported. 810 * @hide 811 */ 812 public boolean isBatchedScanSupported() { 813 try { 814 return mService.isBatchedScanSupported(); 815 } catch (RemoteException e) { return false; } 816 } 817 818 /** 819 * End a requested batch scan for this applicaiton. Note that batched scan may 820 * still occur if other apps are using them. 821 * @hide 822 */ 823 public void stopBatchedScan(BatchedScanSettings requested) { 824 try { 825 mService.stopBatchedScan(requested, new Binder()); 826 } catch (RemoteException e) {} 827 } 828 829 /** 830 * Retrieve the latest batched scan result. This should be called immediately after 831 * {@link BATCHED_SCAN_RESULTS_AVAILABLE_ACTION} is received. 832 * @hide 833 */ 834 public List<BatchedScanResult> getBatchedScanResults() { 835 try { 836 return mService.getBatchedScanResults(mContext.getBasePackageName()); 837 } catch (RemoteException e) { 838 return null; 839 } 840 } 841 842 /** 843 * Force a re-reading of batched scan results. This will attempt 844 * to read more information from the chip, but will do so at the expense 845 * of previous data. Rate limited to the current scan frequency. 846 * 847 * pollBatchedScan will always wait 1 period from the start of the batch 848 * before trying to read from the chip, so if your #scans/batch == 1 this will 849 * have no effect. 850 * 851 * If you had already waited 1 period before calling, this should have 852 * immediate (though async) effect. 853 * 854 * If you call before that 1 period is up this will set up a timer and fetch 855 * results when the 1 period is up. 856 * 857 * Servicing a pollBatchedScan request (immediate or after timed delay) starts a 858 * new batch, so if you were doing 10 scans/batch and called in the 4th scan, you 859 * would get data in the 4th and then again 10 scans later. 860 * @hide 861 */ 862 public void pollBatchedScan() { 863 try { 864 mService.pollBatchedScan(); 865 } catch (RemoteException e) { } 866 } 867 868 /** 869 * Return dynamic information about the current Wi-Fi connection, if any is active. 870 * @return the Wi-Fi information, contained in {@link WifiInfo}. 871 */ 872 public WifiInfo getConnectionInfo() { 873 try { 874 return mService.getConnectionInfo(); 875 } catch (RemoteException e) { 876 return null; 877 } 878 } 879 880 /** 881 * Return the results of the latest access point scan. 882 * @return the list of access points found in the most recent scan. 883 */ 884 public List<ScanResult> getScanResults() { 885 try { 886 return mService.getScanResults(mContext.getBasePackageName()); 887 } catch (RemoteException e) { 888 return null; 889 } 890 } 891 892 /** 893 * Check if scanning is always available. 894 * 895 * If this return {@code true}, apps can issue {@link #startScan} and fetch scan results 896 * even when Wi-Fi is turned off. 897 * 898 * To change this setting, see {@link #ACTION_REQUEST_SCAN_ALWAYS_AVAILABLE}. 899 */ 900 public boolean isScanAlwaysAvailable() { 901 try { 902 return mService.isScanAlwaysAvailable(); 903 } catch (RemoteException e) { 904 return false; 905 } 906 } 907 908 /** 909 * Tell the supplicant to persist the current list of configured networks. 910 * <p> 911 * Note: It is possible for this method to change the network IDs of 912 * existing networks. You should assume the network IDs can be different 913 * after calling this method. 914 * 915 * @return {@code true} if the operation succeeded 916 */ 917 public boolean saveConfiguration() { 918 try { 919 return mService.saveConfiguration(); 920 } catch (RemoteException e) { 921 return false; 922 } 923 } 924 925 /** 926 * Set the country code. 927 * @param countryCode country code in ISO 3166 format. 928 * @param persist {@code true} if this needs to be remembered 929 * 930 * @hide 931 */ 932 public void setCountryCode(String country, boolean persist) { 933 try { 934 mService.setCountryCode(country, persist); 935 } catch (RemoteException e) { } 936 } 937 938 /** 939 * Set the operational frequency band. 940 * @param band One of 941 * {@link #WIFI_FREQUENCY_BAND_AUTO}, 942 * {@link #WIFI_FREQUENCY_BAND_5GHZ}, 943 * {@link #WIFI_FREQUENCY_BAND_2GHZ}, 944 * @param persist {@code true} if this needs to be remembered 945 * @hide 946 */ 947 public void setFrequencyBand(int band, boolean persist) { 948 try { 949 mService.setFrequencyBand(band, persist); 950 } catch (RemoteException e) { } 951 } 952 953 /** 954 * Get the operational frequency band. 955 * @return One of 956 * {@link #WIFI_FREQUENCY_BAND_AUTO}, 957 * {@link #WIFI_FREQUENCY_BAND_5GHZ}, 958 * {@link #WIFI_FREQUENCY_BAND_2GHZ} or 959 * {@code -1} on failure. 960 * @hide 961 */ 962 public int getFrequencyBand() { 963 try { 964 return mService.getFrequencyBand(); 965 } catch (RemoteException e) { 966 return -1; 967 } 968 } 969 970 /** 971 * Check if the chipset supports dual frequency band (2.4 GHz and 5 GHz) 972 * @return {@code true} if supported, {@code false} otherwise. 973 * @hide 974 */ 975 public boolean isDualBandSupported() { 976 try { 977 return mService.isDualBandSupported(); 978 } catch (RemoteException e) { 979 return false; 980 } 981 } 982 983 /** 984 * Return the DHCP-assigned addresses from the last successful DHCP request, 985 * if any. 986 * @return the DHCP information 987 * @deprecated - use ConnectivityManager.getLinkProperties instead. TODO - remove 11/2013 988 */ 989 public DhcpInfo getDhcpInfo() { 990 try { 991 return mService.getDhcpInfo(); 992 } catch (RemoteException e) { 993 return null; 994 } 995 } 996 997 /** 998 * Enable or disable Wi-Fi. 999 * @param enabled {@code true} to enable, {@code false} to disable. 1000 * @return {@code true} if the operation succeeds (or if the existing state 1001 * is the same as the requested state). 1002 */ 1003 public boolean setWifiEnabled(boolean enabled) { 1004 try { 1005 return mService.setWifiEnabled(enabled); 1006 } catch (RemoteException e) { 1007 return false; 1008 } 1009 } 1010 1011 /** 1012 * Gets the Wi-Fi enabled state. 1013 * @return One of {@link #WIFI_STATE_DISABLED}, 1014 * {@link #WIFI_STATE_DISABLING}, {@link #WIFI_STATE_ENABLED}, 1015 * {@link #WIFI_STATE_ENABLING}, {@link #WIFI_STATE_UNKNOWN} 1016 * @see #isWifiEnabled() 1017 */ 1018 public int getWifiState() { 1019 try { 1020 return mService.getWifiEnabledState(); 1021 } catch (RemoteException e) { 1022 return WIFI_STATE_UNKNOWN; 1023 } 1024 } 1025 1026 /** 1027 * Return whether Wi-Fi is enabled or disabled. 1028 * @return {@code true} if Wi-Fi is enabled 1029 * @see #getWifiState() 1030 */ 1031 public boolean isWifiEnabled() { 1032 return getWifiState() == WIFI_STATE_ENABLED; 1033 } 1034 1035 /** 1036 * Return TX packet counter, for CTS test of WiFi watchdog. 1037 * @param listener is the interface to receive result 1038 * 1039 * @hide for CTS test only 1040 */ 1041 public void getTxPacketCount(TxPacketCountListener listener) { 1042 validateChannel(); 1043 sAsyncChannel.sendMessage(RSSI_PKTCNT_FETCH, 0, putListener(listener)); 1044 } 1045 1046 /** 1047 * Calculates the level of the signal. This should be used any time a signal 1048 * is being shown. 1049 * 1050 * @param rssi The power of the signal measured in RSSI. 1051 * @param numLevels The number of levels to consider in the calculated 1052 * level. 1053 * @return A level of the signal, given in the range of 0 to numLevels-1 1054 * (both inclusive). 1055 */ 1056 public static int calculateSignalLevel(int rssi, int numLevels) { 1057 if (rssi <= MIN_RSSI) { 1058 return 0; 1059 } else if (rssi >= MAX_RSSI) { 1060 return numLevels - 1; 1061 } else { 1062 float inputRange = (MAX_RSSI - MIN_RSSI); 1063 float outputRange = (numLevels - 1); 1064 return (int)((float)(rssi - MIN_RSSI) * outputRange / inputRange); 1065 } 1066 } 1067 1068 /** 1069 * Compares two signal strengths. 1070 * 1071 * @param rssiA The power of the first signal measured in RSSI. 1072 * @param rssiB The power of the second signal measured in RSSI. 1073 * @return Returns <0 if the first signal is weaker than the second signal, 1074 * 0 if the two signals have the same strength, and >0 if the first 1075 * signal is stronger than the second signal. 1076 */ 1077 public static int compareSignalLevel(int rssiA, int rssiB) { 1078 return rssiA - rssiB; 1079 } 1080 1081 /** 1082 * Start AccessPoint mode with the specified 1083 * configuration. If the radio is already running in 1084 * AP mode, update the new configuration 1085 * Note that starting in access point mode disables station 1086 * mode operation 1087 * @param wifiConfig SSID, security and channel details as 1088 * part of WifiConfiguration 1089 * @return {@code true} if the operation succeeds, {@code false} otherwise 1090 * 1091 * @hide Dont open up yet 1092 */ 1093 public boolean setWifiApEnabled(WifiConfiguration wifiConfig, boolean enabled) { 1094 try { 1095 mService.setWifiApEnabled(wifiConfig, enabled); 1096 return true; 1097 } catch (RemoteException e) { 1098 return false; 1099 } 1100 } 1101 1102 /** 1103 * Gets the Wi-Fi enabled state. 1104 * @return One of {@link #WIFI_AP_STATE_DISABLED}, 1105 * {@link #WIFI_AP_STATE_DISABLING}, {@link #WIFI_AP_STATE_ENABLED}, 1106 * {@link #WIFI_AP_STATE_ENABLING}, {@link #WIFI_AP_STATE_FAILED} 1107 * @see #isWifiApEnabled() 1108 * 1109 * @hide Dont open yet 1110 */ 1111 public int getWifiApState() { 1112 try { 1113 return mService.getWifiApEnabledState(); 1114 } catch (RemoteException e) { 1115 return WIFI_AP_STATE_FAILED; 1116 } 1117 } 1118 1119 /** 1120 * Return whether Wi-Fi AP is enabled or disabled. 1121 * @return {@code true} if Wi-Fi AP is enabled 1122 * @see #getWifiApState() 1123 * 1124 * @hide Dont open yet 1125 */ 1126 public boolean isWifiApEnabled() { 1127 return getWifiApState() == WIFI_AP_STATE_ENABLED; 1128 } 1129 1130 /** 1131 * Gets the Wi-Fi AP Configuration. 1132 * @return AP details in WifiConfiguration 1133 * 1134 * @hide Dont open yet 1135 */ 1136 public WifiConfiguration getWifiApConfiguration() { 1137 try { 1138 return mService.getWifiApConfiguration(); 1139 } catch (RemoteException e) { 1140 return null; 1141 } 1142 } 1143 1144 /** 1145 * Sets the Wi-Fi AP Configuration. 1146 * @return {@code true} if the operation succeeded, {@code false} otherwise 1147 * 1148 * @hide Dont open yet 1149 */ 1150 public boolean setWifiApConfiguration(WifiConfiguration wifiConfig) { 1151 try { 1152 mService.setWifiApConfiguration(wifiConfig); 1153 return true; 1154 } catch (RemoteException e) { 1155 return false; 1156 } 1157 } 1158 1159 /** 1160 * Start the driver and connect to network. 1161 * 1162 * This function will over-ride WifiLock and device idle status. For example, 1163 * even if the device is idle or there is only a scan-only lock held, 1164 * a start wifi would mean that wifi connection is kept active until 1165 * a stopWifi() is sent. 1166 * 1167 * This API is used by WifiStateTracker 1168 * 1169 * @return {@code true} if the operation succeeds else {@code false} 1170 * @hide 1171 */ 1172 public boolean startWifi() { 1173 try { 1174 mService.startWifi(); 1175 return true; 1176 } catch (RemoteException e) { 1177 return false; 1178 } 1179 } 1180 1181 /** 1182 * Disconnect from a network (if any) and stop the driver. 1183 * 1184 * This function will over-ride WifiLock and device idle status. Wi-Fi 1185 * stays inactive until a startWifi() is issued. 1186 * 1187 * This API is used by WifiStateTracker 1188 * 1189 * @return {@code true} if the operation succeeds else {@code false} 1190 * @hide 1191 */ 1192 public boolean stopWifi() { 1193 try { 1194 mService.stopWifi(); 1195 return true; 1196 } catch (RemoteException e) { 1197 return false; 1198 } 1199 } 1200 1201 /** 1202 * Add a bssid to the supplicant blacklist 1203 * 1204 * This API is used by WifiWatchdogService 1205 * 1206 * @return {@code true} if the operation succeeds else {@code false} 1207 * @hide 1208 */ 1209 public boolean addToBlacklist(String bssid) { 1210 try { 1211 mService.addToBlacklist(bssid); 1212 return true; 1213 } catch (RemoteException e) { 1214 return false; 1215 } 1216 } 1217 1218 /** 1219 * Clear the supplicant blacklist 1220 * 1221 * This API is used by WifiWatchdogService 1222 * 1223 * @return {@code true} if the operation succeeds else {@code false} 1224 * @hide 1225 */ 1226 public boolean clearBlacklist() { 1227 try { 1228 mService.clearBlacklist(); 1229 return true; 1230 } catch (RemoteException e) { 1231 return false; 1232 } 1233 } 1234 1235 1236 /** 1237 * Enable/Disable TDLS on a specific local route. 1238 * 1239 * <p> 1240 * TDLS enables two wireless endpoints to talk to each other directly 1241 * without going through the access point that is managing the local 1242 * network. It saves bandwidth and improves quality of the link. 1243 * </p> 1244 * <p> 1245 * This API enables/disables the option of using TDLS. If enabled, the 1246 * underlying hardware is free to use TDLS or a hop through the access 1247 * point. If disabled, existing TDLS session is torn down and 1248 * hardware is restricted to use access point for transferring wireless 1249 * packets. Default value for all routes is 'disabled', meaning restricted 1250 * to use access point for transferring packets. 1251 * </p> 1252 * 1253 * @param remoteIPAddress IP address of the endpoint to setup TDLS with 1254 * @param enable true = setup and false = tear down TDLS 1255 */ 1256 public void setTdlsEnabled(InetAddress remoteIPAddress, boolean enable) { 1257 try { 1258 mService.enableTdls(remoteIPAddress.getHostAddress(), enable); 1259 } catch (RemoteException e) { 1260 // Just ignore the exception 1261 } 1262 } 1263 1264 /** 1265 * Similar to {@link #setTdlsEnabled(InetAddress, boolean) }, except 1266 * this version allows you to specify remote endpoint with a MAC address. 1267 * @param remoteMacAddress MAC address of the remote endpoint such as 00:00:0c:9f:f2:ab 1268 * @param enable true = setup and false = tear down TDLS 1269 */ 1270 public void setTdlsEnabledWithMacAddress(String remoteMacAddress, boolean enable) { 1271 try { 1272 mService.enableTdlsWithMacAddress(remoteMacAddress, enable); 1273 } catch (RemoteException e) { 1274 // Just ignore the exception 1275 } 1276 } 1277 1278 /* TODO: deprecate synchronous API and open up the following API */ 1279 1280 private static final int BASE = Protocol.BASE_WIFI_MANAGER; 1281 1282 /* Commands to WifiService */ 1283 /** @hide */ 1284 public static final int CONNECT_NETWORK = BASE + 1; 1285 /** @hide */ 1286 public static final int CONNECT_NETWORK_FAILED = BASE + 2; 1287 /** @hide */ 1288 public static final int CONNECT_NETWORK_SUCCEEDED = BASE + 3; 1289 1290 /** @hide */ 1291 public static final int FORGET_NETWORK = BASE + 4; 1292 /** @hide */ 1293 public static final int FORGET_NETWORK_FAILED = BASE + 5; 1294 /** @hide */ 1295 public static final int FORGET_NETWORK_SUCCEEDED = BASE + 6; 1296 1297 /** @hide */ 1298 public static final int SAVE_NETWORK = BASE + 7; 1299 /** @hide */ 1300 public static final int SAVE_NETWORK_FAILED = BASE + 8; 1301 /** @hide */ 1302 public static final int SAVE_NETWORK_SUCCEEDED = BASE + 9; 1303 1304 /** @hide */ 1305 public static final int START_WPS = BASE + 10; 1306 /** @hide */ 1307 public static final int START_WPS_SUCCEEDED = BASE + 11; 1308 /** @hide */ 1309 public static final int WPS_FAILED = BASE + 12; 1310 /** @hide */ 1311 public static final int WPS_COMPLETED = BASE + 13; 1312 1313 /** @hide */ 1314 public static final int CANCEL_WPS = BASE + 14; 1315 /** @hide */ 1316 public static final int CANCEL_WPS_FAILED = BASE + 15; 1317 /** @hide */ 1318 public static final int CANCEL_WPS_SUCCEDED = BASE + 16; 1319 1320 /** @hide */ 1321 public static final int DISABLE_NETWORK = BASE + 17; 1322 /** @hide */ 1323 public static final int DISABLE_NETWORK_FAILED = BASE + 18; 1324 /** @hide */ 1325 public static final int DISABLE_NETWORK_SUCCEEDED = BASE + 19; 1326 1327 /** @hide */ 1328 public static final int RSSI_PKTCNT_FETCH = BASE + 20; 1329 /** @hide */ 1330 public static final int RSSI_PKTCNT_FETCH_SUCCEEDED = BASE + 21; 1331 /** @hide */ 1332 public static final int RSSI_PKTCNT_FETCH_FAILED = BASE + 22; 1333 1334 1335 /** 1336 * Passed with {@link ActionListener#onFailure}. 1337 * Indicates that the operation failed due to an internal error. 1338 * @hide 1339 */ 1340 public static final int ERROR = 0; 1341 1342 /** 1343 * Passed with {@link ActionListener#onFailure}. 1344 * Indicates that the operation is already in progress 1345 * @hide 1346 */ 1347 public static final int IN_PROGRESS = 1; 1348 1349 /** 1350 * Passed with {@link ActionListener#onFailure}. 1351 * Indicates that the operation failed because the framework is busy and 1352 * unable to service the request 1353 * @hide 1354 */ 1355 public static final int BUSY = 2; 1356 1357 /* WPS specific errors */ 1358 /** WPS overlap detected {@hide} */ 1359 public static final int WPS_OVERLAP_ERROR = 3; 1360 /** WEP on WPS is prohibited {@hide} */ 1361 public static final int WPS_WEP_PROHIBITED = 4; 1362 /** TKIP only prohibited {@hide} */ 1363 public static final int WPS_TKIP_ONLY_PROHIBITED = 5; 1364 /** Authentication failure on WPS {@hide} */ 1365 public static final int WPS_AUTH_FAILURE = 6; 1366 /** WPS timed out {@hide} */ 1367 public static final int WPS_TIMED_OUT = 7; 1368 1369 /** 1370 * Passed with {@link ActionListener#onFailure}. 1371 * Indicates that the operation failed due to invalid inputs 1372 * @hide 1373 */ 1374 public static final int INVALID_ARGS = 8; 1375 1376 /** Interface for callback invocation on an application action {@hide} */ 1377 public interface ActionListener { 1378 /** The operation succeeded */ 1379 public void onSuccess(); 1380 /** 1381 * The operation failed 1382 * @param reason The reason for failure could be one of 1383 * {@link #ERROR}, {@link #IN_PROGRESS} or {@link #BUSY} 1384 */ 1385 public void onFailure(int reason); 1386 } 1387 1388 /** Interface for callback invocation on a start WPS action {@hide} */ 1389 public interface WpsListener { 1390 /** WPS start succeeded */ 1391 public void onStartSuccess(String pin); 1392 1393 /** WPS operation completed succesfully */ 1394 public void onCompletion(); 1395 1396 /** 1397 * WPS operation failed 1398 * @param reason The reason for failure could be one of 1399 * {@link #IN_PROGRESS}, {@link #WPS_OVERLAP_ERROR},{@link #ERROR} or {@link #BUSY} 1400 */ 1401 public void onFailure(int reason); 1402 } 1403 1404 /** Interface for callback invocation on a TX packet count poll action {@hide} */ 1405 public interface TxPacketCountListener { 1406 /** 1407 * The operation succeeded 1408 * @param count TX packet counter 1409 */ 1410 public void onSuccess(int count); 1411 /** 1412 * The operation failed 1413 * @param reason The reason for failure could be one of 1414 * {@link #ERROR}, {@link #IN_PROGRESS} or {@link #BUSY} 1415 */ 1416 public void onFailure(int reason); 1417 } 1418 1419 private static class ServiceHandler extends Handler { 1420 ServiceHandler(Looper looper) { 1421 super(looper); 1422 } 1423 1424 @Override 1425 public void handleMessage(Message message) { 1426 Object listener = removeListener(message.arg2); 1427 switch (message.what) { 1428 case AsyncChannel.CMD_CHANNEL_HALF_CONNECTED: 1429 if (message.arg1 == AsyncChannel.STATUS_SUCCESSFUL) { 1430 sAsyncChannel.sendMessage(AsyncChannel.CMD_CHANNEL_FULL_CONNECTION); 1431 } else { 1432 Log.e(TAG, "Failed to set up channel connection"); 1433 // This will cause all further async API calls on the WifiManager 1434 // to fail and throw an exception 1435 sAsyncChannel = null; 1436 } 1437 sConnected.countDown(); 1438 break; 1439 case AsyncChannel.CMD_CHANNEL_FULLY_CONNECTED: 1440 // Ignore 1441 break; 1442 case AsyncChannel.CMD_CHANNEL_DISCONNECTED: 1443 Log.e(TAG, "Channel connection lost"); 1444 // This will cause all further async API calls on the WifiManager 1445 // to fail and throw an exception 1446 sAsyncChannel = null; 1447 getLooper().quit(); 1448 break; 1449 /* ActionListeners grouped together */ 1450 case WifiManager.CONNECT_NETWORK_FAILED: 1451 case WifiManager.FORGET_NETWORK_FAILED: 1452 case WifiManager.SAVE_NETWORK_FAILED: 1453 case WifiManager.CANCEL_WPS_FAILED: 1454 case WifiManager.DISABLE_NETWORK_FAILED: 1455 if (listener != null) { 1456 ((ActionListener) listener).onFailure(message.arg1); 1457 } 1458 break; 1459 /* ActionListeners grouped together */ 1460 case WifiManager.CONNECT_NETWORK_SUCCEEDED: 1461 case WifiManager.FORGET_NETWORK_SUCCEEDED: 1462 case WifiManager.SAVE_NETWORK_SUCCEEDED: 1463 case WifiManager.CANCEL_WPS_SUCCEDED: 1464 case WifiManager.DISABLE_NETWORK_SUCCEEDED: 1465 if (listener != null) { 1466 ((ActionListener) listener).onSuccess(); 1467 } 1468 break; 1469 case WifiManager.START_WPS_SUCCEEDED: 1470 if (listener != null) { 1471 WpsResult result = (WpsResult) message.obj; 1472 ((WpsListener) listener).onStartSuccess(result.pin); 1473 //Listener needs to stay until completion or failure 1474 synchronized(sListenerMapLock) { 1475 sListenerMap.put(message.arg2, listener); 1476 } 1477 } 1478 break; 1479 case WifiManager.WPS_COMPLETED: 1480 if (listener != null) { 1481 ((WpsListener) listener).onCompletion(); 1482 } 1483 break; 1484 case WifiManager.WPS_FAILED: 1485 if (listener != null) { 1486 ((WpsListener) listener).onFailure(message.arg1); 1487 } 1488 break; 1489 case WifiManager.RSSI_PKTCNT_FETCH_SUCCEEDED: 1490 if (listener != null) { 1491 RssiPacketCountInfo info = (RssiPacketCountInfo) message.obj; 1492 if (info != null) 1493 ((TxPacketCountListener) listener).onSuccess(info.txgood + info.txbad); 1494 else 1495 ((TxPacketCountListener) listener).onFailure(ERROR); 1496 } 1497 break; 1498 case WifiManager.RSSI_PKTCNT_FETCH_FAILED: 1499 if (listener != null) { 1500 ((TxPacketCountListener) listener).onFailure(message.arg1); 1501 } 1502 break; 1503 default: 1504 //ignore 1505 break; 1506 } 1507 } 1508 } 1509 1510 private static int putListener(Object listener) { 1511 if (listener == null) return INVALID_KEY; 1512 int key; 1513 synchronized (sListenerMapLock) { 1514 do { 1515 key = sListenerKey++; 1516 } while (key == INVALID_KEY); 1517 sListenerMap.put(key, listener); 1518 } 1519 return key; 1520 } 1521 1522 private static Object removeListener(int key) { 1523 if (key == INVALID_KEY) return null; 1524 synchronized (sListenerMapLock) { 1525 Object listener = sListenerMap.get(key); 1526 sListenerMap.remove(key); 1527 return listener; 1528 } 1529 } 1530 1531 private void init() { 1532 synchronized (sThreadRefLock) { 1533 if (++sThreadRefCount == 1) { 1534 Messenger messenger = getWifiServiceMessenger(); 1535 if (messenger == null) { 1536 sAsyncChannel = null; 1537 return; 1538 } 1539 1540 sHandlerThread = new HandlerThread("WifiManager"); 1541 sAsyncChannel = new AsyncChannel(); 1542 sConnected = new CountDownLatch(1); 1543 1544 sHandlerThread.start(); 1545 Handler handler = new ServiceHandler(sHandlerThread.getLooper()); 1546 sAsyncChannel.connect(mContext, handler, messenger); 1547 try { 1548 sConnected.await(); 1549 } catch (InterruptedException e) { 1550 Log.e(TAG, "interrupted wait at init"); 1551 } 1552 } 1553 } 1554 } 1555 1556 private void validateChannel() { 1557 if (sAsyncChannel == null) throw new IllegalStateException( 1558 "No permission to access and change wifi or a bad initialization"); 1559 } 1560 1561 /** 1562 * Connect to a network with the given configuration. The network also 1563 * gets added to the supplicant configuration. 1564 * 1565 * For a new network, this function is used instead of a 1566 * sequence of addNetwork(), enableNetwork(), saveConfiguration() and 1567 * reconnect() 1568 * 1569 * @param config the set of variables that describe the configuration, 1570 * contained in a {@link WifiConfiguration} object. 1571 * @param listener for callbacks on success or failure. Can be null. 1572 * @throws IllegalStateException if the WifiManager instance needs to be 1573 * initialized again 1574 * 1575 * @hide 1576 */ 1577 public void connect(WifiConfiguration config, ActionListener listener) { 1578 if (config == null) throw new IllegalArgumentException("config cannot be null"); 1579 validateChannel(); 1580 // Use INVALID_NETWORK_ID for arg1 when passing a config object 1581 // arg1 is used to pass network id when the network already exists 1582 sAsyncChannel.sendMessage(CONNECT_NETWORK, WifiConfiguration.INVALID_NETWORK_ID, 1583 putListener(listener), config); 1584 } 1585 1586 /** 1587 * Connect to a network with the given networkId. 1588 * 1589 * This function is used instead of a enableNetwork(), saveConfiguration() and 1590 * reconnect() 1591 * 1592 * @param networkId the network id identifiying the network in the 1593 * supplicant configuration list 1594 * @param listener for callbacks on success or failure. Can be null. 1595 * @throws IllegalStateException if the WifiManager instance needs to be 1596 * initialized again 1597 * @hide 1598 */ 1599 public void connect(int networkId, ActionListener listener) { 1600 if (networkId < 0) throw new IllegalArgumentException("Network id cannot be negative"); 1601 validateChannel(); 1602 sAsyncChannel.sendMessage(CONNECT_NETWORK, networkId, putListener(listener)); 1603 } 1604 1605 /** 1606 * Save the given network in the supplicant config. If the network already 1607 * exists, the configuration is updated. A new network is enabled 1608 * by default. 1609 * 1610 * For a new network, this function is used instead of a 1611 * sequence of addNetwork(), enableNetwork() and saveConfiguration(). 1612 * 1613 * For an existing network, it accomplishes the task of updateNetwork() 1614 * and saveConfiguration() 1615 * 1616 * @param config the set of variables that describe the configuration, 1617 * contained in a {@link WifiConfiguration} object. 1618 * @param listener for callbacks on success or failure. Can be null. 1619 * @throws IllegalStateException if the WifiManager instance needs to be 1620 * initialized again 1621 * @hide 1622 */ 1623 public void save(WifiConfiguration config, ActionListener listener) { 1624 if (config == null) throw new IllegalArgumentException("config cannot be null"); 1625 validateChannel(); 1626 sAsyncChannel.sendMessage(SAVE_NETWORK, 0, putListener(listener), config); 1627 } 1628 1629 /** 1630 * Delete the network in the supplicant config. 1631 * 1632 * This function is used instead of a sequence of removeNetwork() 1633 * and saveConfiguration(). 1634 * 1635 * @param config the set of variables that describe the configuration, 1636 * contained in a {@link WifiConfiguration} object. 1637 * @param listener for callbacks on success or failure. Can be null. 1638 * @throws IllegalStateException if the WifiManager instance needs to be 1639 * initialized again 1640 * @hide 1641 */ 1642 public void forget(int netId, ActionListener listener) { 1643 if (netId < 0) throw new IllegalArgumentException("Network id cannot be negative"); 1644 validateChannel(); 1645 sAsyncChannel.sendMessage(FORGET_NETWORK, netId, putListener(listener)); 1646 } 1647 1648 /** 1649 * Disable network 1650 * 1651 * @param netId is the network Id 1652 * @param listener for callbacks on success or failure. Can be null. 1653 * @throws IllegalStateException if the WifiManager instance needs to be 1654 * initialized again 1655 * @hide 1656 */ 1657 public void disable(int netId, ActionListener listener) { 1658 if (netId < 0) throw new IllegalArgumentException("Network id cannot be negative"); 1659 validateChannel(); 1660 sAsyncChannel.sendMessage(DISABLE_NETWORK, netId, putListener(listener)); 1661 } 1662 1663 /** 1664 * Start Wi-fi Protected Setup 1665 * 1666 * @param config WPS configuration 1667 * @param listener for callbacks on success or failure. Can be null. 1668 * @throws IllegalStateException if the WifiManager instance needs to be 1669 * initialized again 1670 * @hide 1671 */ 1672 public void startWps(WpsInfo config, WpsListener listener) { 1673 if (config == null) throw new IllegalArgumentException("config cannot be null"); 1674 validateChannel(); 1675 sAsyncChannel.sendMessage(START_WPS, 0, putListener(listener), config); 1676 } 1677 1678 /** 1679 * Cancel any ongoing Wi-fi Protected Setup 1680 * 1681 * @param listener for callbacks on success or failure. Can be null. 1682 * @throws IllegalStateException if the WifiManager instance needs to be 1683 * initialized again 1684 * @hide 1685 */ 1686 public void cancelWps(ActionListener listener) { 1687 validateChannel(); 1688 sAsyncChannel.sendMessage(CANCEL_WPS, 0, putListener(listener)); 1689 } 1690 1691 /** 1692 * Get a reference to WifiService handler. This is used by a client to establish 1693 * an AsyncChannel communication with WifiService 1694 * 1695 * @return Messenger pointing to the WifiService handler 1696 * @hide 1697 */ 1698 public Messenger getWifiServiceMessenger() { 1699 try { 1700 return mService.getWifiServiceMessenger(); 1701 } catch (RemoteException e) { 1702 return null; 1703 } catch (SecurityException e) { 1704 return null; 1705 } 1706 } 1707 1708 /** 1709 * Get a reference to WifiStateMachine handler. 1710 * @return Messenger pointing to the WifiService handler 1711 * @hide 1712 */ 1713 public Messenger getWifiStateMachineMessenger() { 1714 try { 1715 return mService.getWifiStateMachineMessenger(); 1716 } catch (RemoteException e) { 1717 return null; 1718 } 1719 } 1720 1721 /** 1722 * Returns the file in which IP and proxy configuration data is stored 1723 * @hide 1724 */ 1725 public String getConfigFile() { 1726 try { 1727 return mService.getConfigFile(); 1728 } catch (RemoteException e) { 1729 return null; 1730 } 1731 } 1732 1733 /** 1734 * Allows an application to keep the Wi-Fi radio awake. 1735 * Normally the Wi-Fi radio may turn off when the user has not used the device in a while. 1736 * Acquiring a WifiLock will keep the radio on until the lock is released. Multiple 1737 * applications may hold WifiLocks, and the radio will only be allowed to turn off when no 1738 * WifiLocks are held in any application. 1739 * <p> 1740 * Before using a WifiLock, consider carefully if your application requires Wi-Fi access, or 1741 * could function over a mobile network, if available. A program that needs to download large 1742 * files should hold a WifiLock to ensure that the download will complete, but a program whose 1743 * network usage is occasional or low-bandwidth should not hold a WifiLock to avoid adversely 1744 * affecting battery life. 1745 * <p> 1746 * Note that WifiLocks cannot override the user-level "Wi-Fi Enabled" setting, nor Airplane 1747 * Mode. They simply keep the radio from turning off when Wi-Fi is already on but the device 1748 * is idle. 1749 * <p> 1750 * Any application using a WifiLock must request the {@code android.permission.WAKE_LOCK} 1751 * permission in an {@code <uses-permission>} element of the application's manifest. 1752 */ 1753 public class WifiLock { 1754 private String mTag; 1755 private final IBinder mBinder; 1756 private int mRefCount; 1757 int mLockType; 1758 private boolean mRefCounted; 1759 private boolean mHeld; 1760 private WorkSource mWorkSource; 1761 1762 private WifiLock(int lockType, String tag) { 1763 mTag = tag; 1764 mLockType = lockType; 1765 mBinder = new Binder(); 1766 mRefCount = 0; 1767 mRefCounted = true; 1768 mHeld = false; 1769 } 1770 1771 /** 1772 * Locks the Wi-Fi radio on until {@link #release} is called. 1773 * 1774 * If this WifiLock is reference-counted, each call to {@code acquire} will increment the 1775 * reference count, and the radio will remain locked as long as the reference count is 1776 * above zero. 1777 * 1778 * If this WifiLock is not reference-counted, the first call to {@code acquire} will lock 1779 * the radio, but subsequent calls will be ignored. Only one call to {@link #release} 1780 * will be required, regardless of the number of times that {@code acquire} is called. 1781 */ 1782 public void acquire() { 1783 synchronized (mBinder) { 1784 if (mRefCounted ? (++mRefCount == 1) : (!mHeld)) { 1785 try { 1786 mService.acquireWifiLock(mBinder, mLockType, mTag, mWorkSource); 1787 synchronized (WifiManager.this) { 1788 if (mActiveLockCount >= MAX_ACTIVE_LOCKS) { 1789 mService.releaseWifiLock(mBinder); 1790 throw new UnsupportedOperationException( 1791 "Exceeded maximum number of wifi locks"); 1792 } 1793 mActiveLockCount++; 1794 } 1795 } catch (RemoteException ignore) { 1796 } 1797 mHeld = true; 1798 } 1799 } 1800 } 1801 1802 /** 1803 * Unlocks the Wi-Fi radio, allowing it to turn off when the device is idle. 1804 * 1805 * If this WifiLock is reference-counted, each call to {@code release} will decrement the 1806 * reference count, and the radio will be unlocked only when the reference count reaches 1807 * zero. If the reference count goes below zero (that is, if {@code release} is called 1808 * a greater number of times than {@link #acquire}), an exception is thrown. 1809 * 1810 * If this WifiLock is not reference-counted, the first call to {@code release} (after 1811 * the radio was locked using {@link #acquire}) will unlock the radio, and subsequent 1812 * calls will be ignored. 1813 */ 1814 public void release() { 1815 synchronized (mBinder) { 1816 if (mRefCounted ? (--mRefCount == 0) : (mHeld)) { 1817 try { 1818 mService.releaseWifiLock(mBinder); 1819 synchronized (WifiManager.this) { 1820 mActiveLockCount--; 1821 } 1822 } catch (RemoteException ignore) { 1823 } 1824 mHeld = false; 1825 } 1826 if (mRefCount < 0) { 1827 throw new RuntimeException("WifiLock under-locked " + mTag); 1828 } 1829 } 1830 } 1831 1832 /** 1833 * Controls whether this is a reference-counted or non-reference-counted WifiLock. 1834 * 1835 * Reference-counted WifiLocks keep track of the number of calls to {@link #acquire} and 1836 * {@link #release}, and only allow the radio to sleep when every call to {@link #acquire} 1837 * has been balanced with a call to {@link #release}. Non-reference-counted WifiLocks 1838 * lock the radio whenever {@link #acquire} is called and it is unlocked, and unlock the 1839 * radio whenever {@link #release} is called and it is locked. 1840 * 1841 * @param refCounted true if this WifiLock should keep a reference count 1842 */ 1843 public void setReferenceCounted(boolean refCounted) { 1844 mRefCounted = refCounted; 1845 } 1846 1847 /** 1848 * Checks whether this WifiLock is currently held. 1849 * 1850 * @return true if this WifiLock is held, false otherwise 1851 */ 1852 public boolean isHeld() { 1853 synchronized (mBinder) { 1854 return mHeld; 1855 } 1856 } 1857 1858 public void setWorkSource(WorkSource ws) { 1859 synchronized (mBinder) { 1860 if (ws != null && ws.size() == 0) { 1861 ws = null; 1862 } 1863 boolean changed = true; 1864 if (ws == null) { 1865 mWorkSource = null; 1866 } else if (mWorkSource == null) { 1867 changed = mWorkSource != null; 1868 mWorkSource = new WorkSource(ws); 1869 } else { 1870 changed = mWorkSource.diff(ws); 1871 if (changed) { 1872 mWorkSource.set(ws); 1873 } 1874 } 1875 if (changed && mHeld) { 1876 try { 1877 mService.updateWifiLockWorkSource(mBinder, mWorkSource); 1878 } catch (RemoteException e) { 1879 } 1880 } 1881 } 1882 } 1883 1884 public String toString() { 1885 String s1, s2, s3; 1886 synchronized (mBinder) { 1887 s1 = Integer.toHexString(System.identityHashCode(this)); 1888 s2 = mHeld ? "held; " : ""; 1889 if (mRefCounted) { 1890 s3 = "refcounted: refcount = " + mRefCount; 1891 } else { 1892 s3 = "not refcounted"; 1893 } 1894 return "WifiLock{ " + s1 + "; " + s2 + s3 + " }"; 1895 } 1896 } 1897 1898 @Override 1899 protected void finalize() throws Throwable { 1900 super.finalize(); 1901 synchronized (mBinder) { 1902 if (mHeld) { 1903 try { 1904 mService.releaseWifiLock(mBinder); 1905 synchronized (WifiManager.this) { 1906 mActiveLockCount--; 1907 } 1908 } catch (RemoteException ignore) { 1909 } 1910 } 1911 } 1912 } 1913 } 1914 1915 /** 1916 * Creates a new WifiLock. 1917 * 1918 * @param lockType the type of lock to create. See {@link #WIFI_MODE_FULL}, 1919 * {@link #WIFI_MODE_FULL_HIGH_PERF} and {@link #WIFI_MODE_SCAN_ONLY} for 1920 * descriptions of the types of Wi-Fi locks. 1921 * @param tag a tag for the WifiLock to identify it in debugging messages. This string is 1922 * never shown to the user under normal conditions, but should be descriptive 1923 * enough to identify your application and the specific WifiLock within it, if it 1924 * holds multiple WifiLocks. 1925 * 1926 * @return a new, unacquired WifiLock with the given tag. 1927 * 1928 * @see WifiLock 1929 */ 1930 public WifiLock createWifiLock(int lockType, String tag) { 1931 return new WifiLock(lockType, tag); 1932 } 1933 1934 /** 1935 * Creates a new WifiLock. 1936 * 1937 * @param tag a tag for the WifiLock to identify it in debugging messages. This string is 1938 * never shown to the user under normal conditions, but should be descriptive 1939 * enough to identify your application and the specific WifiLock within it, if it 1940 * holds multiple WifiLocks. 1941 * 1942 * @return a new, unacquired WifiLock with the given tag. 1943 * 1944 * @see WifiLock 1945 */ 1946 public WifiLock createWifiLock(String tag) { 1947 return new WifiLock(WIFI_MODE_FULL, tag); 1948 } 1949 1950 1951 /** 1952 * Create a new MulticastLock 1953 * 1954 * @param tag a tag for the MulticastLock to identify it in debugging 1955 * messages. This string is never shown to the user under 1956 * normal conditions, but should be descriptive enough to 1957 * identify your application and the specific MulticastLock 1958 * within it, if it holds multiple MulticastLocks. 1959 * 1960 * @return a new, unacquired MulticastLock with the given tag. 1961 * 1962 * @see MulticastLock 1963 */ 1964 public MulticastLock createMulticastLock(String tag) { 1965 return new MulticastLock(tag); 1966 } 1967 1968 /** 1969 * Allows an application to receive Wifi Multicast packets. 1970 * Normally the Wifi stack filters out packets not explicitly 1971 * addressed to this device. Acquring a MulticastLock will 1972 * cause the stack to receive packets addressed to multicast 1973 * addresses. Processing these extra packets can cause a noticable 1974 * battery drain and should be disabled when not needed. 1975 */ 1976 public class MulticastLock { 1977 private String mTag; 1978 private final IBinder mBinder; 1979 private int mRefCount; 1980 private boolean mRefCounted; 1981 private boolean mHeld; 1982 1983 private MulticastLock(String tag) { 1984 mTag = tag; 1985 mBinder = new Binder(); 1986 mRefCount = 0; 1987 mRefCounted = true; 1988 mHeld = false; 1989 } 1990 1991 /** 1992 * Locks Wifi Multicast on until {@link #release} is called. 1993 * 1994 * If this MulticastLock is reference-counted each call to 1995 * {@code acquire} will increment the reference count, and the 1996 * wifi interface will receive multicast packets as long as the 1997 * reference count is above zero. 1998 * 1999 * If this MulticastLock is not reference-counted, the first call to 2000 * {@code acquire} will turn on the multicast packets, but subsequent 2001 * calls will be ignored. Only one call to {@link #release} will 2002 * be required, regardless of the number of times that {@code acquire} 2003 * is called. 2004 * 2005 * Note that other applications may also lock Wifi Multicast on. 2006 * Only they can relinquish their lock. 2007 * 2008 * Also note that applications cannot leave Multicast locked on. 2009 * When an app exits or crashes, any Multicast locks will be released. 2010 */ 2011 public void acquire() { 2012 synchronized (mBinder) { 2013 if (mRefCounted ? (++mRefCount == 1) : (!mHeld)) { 2014 try { 2015 mService.acquireMulticastLock(mBinder, mTag); 2016 synchronized (WifiManager.this) { 2017 if (mActiveLockCount >= MAX_ACTIVE_LOCKS) { 2018 mService.releaseMulticastLock(); 2019 throw new UnsupportedOperationException( 2020 "Exceeded maximum number of wifi locks"); 2021 } 2022 mActiveLockCount++; 2023 } 2024 } catch (RemoteException ignore) { 2025 } 2026 mHeld = true; 2027 } 2028 } 2029 } 2030 2031 /** 2032 * Unlocks Wifi Multicast, restoring the filter of packets 2033 * not addressed specifically to this device and saving power. 2034 * 2035 * If this MulticastLock is reference-counted, each call to 2036 * {@code release} will decrement the reference count, and the 2037 * multicast packets will only stop being received when the reference 2038 * count reaches zero. If the reference count goes below zero (that 2039 * is, if {@code release} is called a greater number of times than 2040 * {@link #acquire}), an exception is thrown. 2041 * 2042 * If this MulticastLock is not reference-counted, the first call to 2043 * {@code release} (after the radio was multicast locked using 2044 * {@link #acquire}) will unlock the multicast, and subsequent calls 2045 * will be ignored. 2046 * 2047 * Note that if any other Wifi Multicast Locks are still outstanding 2048 * this {@code release} call will not have an immediate effect. Only 2049 * when all applications have released all their Multicast Locks will 2050 * the Multicast filter be turned back on. 2051 * 2052 * Also note that when an app exits or crashes all of its Multicast 2053 * Locks will be automatically released. 2054 */ 2055 public void release() { 2056 synchronized (mBinder) { 2057 if (mRefCounted ? (--mRefCount == 0) : (mHeld)) { 2058 try { 2059 mService.releaseMulticastLock(); 2060 synchronized (WifiManager.this) { 2061 mActiveLockCount--; 2062 } 2063 } catch (RemoteException ignore) { 2064 } 2065 mHeld = false; 2066 } 2067 if (mRefCount < 0) { 2068 throw new RuntimeException("MulticastLock under-locked " 2069 + mTag); 2070 } 2071 } 2072 } 2073 2074 /** 2075 * Controls whether this is a reference-counted or non-reference- 2076 * counted MulticastLock. 2077 * 2078 * Reference-counted MulticastLocks keep track of the number of calls 2079 * to {@link #acquire} and {@link #release}, and only stop the 2080 * reception of multicast packets when every call to {@link #acquire} 2081 * has been balanced with a call to {@link #release}. Non-reference- 2082 * counted MulticastLocks allow the reception of multicast packets 2083 * whenever {@link #acquire} is called and stop accepting multicast 2084 * packets whenever {@link #release} is called. 2085 * 2086 * @param refCounted true if this MulticastLock should keep a reference 2087 * count 2088 */ 2089 public void setReferenceCounted(boolean refCounted) { 2090 mRefCounted = refCounted; 2091 } 2092 2093 /** 2094 * Checks whether this MulticastLock is currently held. 2095 * 2096 * @return true if this MulticastLock is held, false otherwise 2097 */ 2098 public boolean isHeld() { 2099 synchronized (mBinder) { 2100 return mHeld; 2101 } 2102 } 2103 2104 public String toString() { 2105 String s1, s2, s3; 2106 synchronized (mBinder) { 2107 s1 = Integer.toHexString(System.identityHashCode(this)); 2108 s2 = mHeld ? "held; " : ""; 2109 if (mRefCounted) { 2110 s3 = "refcounted: refcount = " + mRefCount; 2111 } else { 2112 s3 = "not refcounted"; 2113 } 2114 return "MulticastLock{ " + s1 + "; " + s2 + s3 + " }"; 2115 } 2116 } 2117 2118 @Override 2119 protected void finalize() throws Throwable { 2120 super.finalize(); 2121 setReferenceCounted(false); 2122 release(); 2123 } 2124 } 2125 2126 /** 2127 * Check multicast filter status. 2128 * 2129 * @return true if multicast packets are allowed. 2130 * 2131 * @hide pending API council approval 2132 */ 2133 public boolean isMulticastEnabled() { 2134 try { 2135 return mService.isMulticastEnabled(); 2136 } catch (RemoteException e) { 2137 return false; 2138 } 2139 } 2140 2141 /** 2142 * Initialize the multicast filtering to 'on' 2143 * @hide no intent to publish 2144 */ 2145 public boolean initializeMulticastFiltering() { 2146 try { 2147 mService.initializeMulticastFiltering(); 2148 return true; 2149 } catch (RemoteException e) { 2150 return false; 2151 } 2152 } 2153 2154 /** @hide */ 2155 public void captivePortalCheckComplete() { 2156 try { 2157 mService.captivePortalCheckComplete(); 2158 } catch (RemoteException e) {} 2159 } 2160 2161 protected void finalize() throws Throwable { 2162 try { 2163 synchronized (sThreadRefLock) { 2164 if (--sThreadRefCount == 0 && sAsyncChannel != null) { 2165 sAsyncChannel.disconnect(); 2166 } 2167 } 2168 } finally { 2169 super.finalize(); 2170 } 2171 } 2172} 2173