WifiLock
open class WifiLock
| kotlin.Any | |
| ↳ | android.net.wifi.WifiManager.WifiLock |
Allows an application to keep the Wi-Fi radio awake. Normally the Wi-Fi radio may turn off when the user has not used the device in a while. Acquiring a WifiLock will keep the radio on until the lock is released. Multiple applications may hold WifiLocks, and the radio will only be allowed to turn off when no WifiLocks are held in any application.
Before using a WifiLock, consider carefully if your application requires Wi-Fi access, or could function over a mobile network, if available. A program that needs to download large files should hold a WifiLock to ensure that the download will complete, but a program whose network usage is occasional or low-bandwidth should not hold a WifiLock to avoid adversely affecting battery life.
Note that WifiLocks cannot override the user-level "Wi-Fi Enabled" setting, nor Airplane Mode. They simply keep the radio from turning off when Wi-Fi is already on but the device is idle.
Any application using a WifiLock must request the android.permission.WAKE_LOCK permission in an <uses-permission> element of the application's manifest.
Summary
| Public methods | |
|---|---|
| open Unit |
acquire()Locks the Wi-Fi radio on until |
| open Boolean |
isHeld()Checks whether this WifiLock is currently held. |
| open Unit |
release()Unlocks the Wi-Fi radio, allowing it to turn off when the device is idle. |
| open Unit |
setReferenceCounted(refCounted: Boolean)Controls whether this is a reference-counted or non-reference-counted WifiLock. |
| open Unit |
setWorkSource(ws: WorkSource!) |
| open String |
toString() |
| Protected methods | |
|---|---|
| open Unit |
finalize() |
Public methods
acquire
open fun acquire(): Unit
Locks the Wi-Fi radio on until release is called. If this WifiLock is reference-counted, each call to acquire will increment the reference count, and the radio will remain locked as long as the reference count is above zero. If this WifiLock is not reference-counted, the first call to acquire will lock the radio, but subsequent calls will be ignored. Only one call to release will be required, regardless of the number of times that acquire is called.
isHeld
open fun isHeld(): Boolean
Checks whether this WifiLock is currently held.
| Return | |
|---|---|
Boolean |
true if this WifiLock is held, false otherwise |
release
open fun release(): Unit
Unlocks the Wi-Fi radio, allowing it to turn off when the device is idle. If this WifiLock is reference-counted, each call to release will decrement the reference count, and the radio will be unlocked only when the reference count reaches zero. If the reference count goes below zero (that is, if release is called a greater number of times than acquire), an exception is thrown. If this WifiLock is not reference-counted, the first call to release (after the radio was locked using acquire) will unlock the radio, and subsequent calls will be ignored.
setReferenceCounted
open fun setReferenceCounted(refCounted: Boolean): Unit
Controls whether this is a reference-counted or non-reference-counted WifiLock. Reference-counted WifiLocks keep track of the number of calls to acquire and release, and only allow the radio to sleep when every call to acquire has been balanced with a call to release. Non-reference-counted WifiLocks lock the radio whenever acquire is called and it is unlocked, and unlock the radio whenever release is called and it is locked.
| Parameters | |
|---|---|
refCounted |
Boolean: true if this WifiLock should keep a reference count |
toString
open fun toString(): String
| Return | |
|---|---|
String |
a string representation of the object. |
Protected methods
finalize
protected open fun finalize(): Unit
| Exceptions | |
|---|---|
java.lang.Throwable |
the Exception raised by this method |