# WifiManager.WifiLock

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# WifiLock

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock "View this page in Java")  

```
open class WifiLock
```

|---|--------------------------------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                                                 ||
| ↳ | [android.net.wifi.WifiManager.WifiLock](https://developer.android.com/reference/kotlin/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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)       | [acquire](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#acquire())`()` Locks the Wi-Fi radio on until[release](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#release())is called.                                                                       |
| open[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [isHeld](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#isHeld())`()` Checks whether this WifiLock is currently held.                                                                                                                                                                           |
| open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)       | [release](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#release())`()` Unlocks the Wi-Fi radio, allowing it to turn off when the device is idle.                                                                                                                                               |
| open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)       | [setReferenceCounted](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#setReferenceCounted(kotlin.Boolean))`(`refCounted:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Controls whether this is a reference-counted or non-reference-counted WifiLock. |
| open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)       | [setWorkSource](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#setWorkSource(android.os.WorkSource))`(`ws:` `[WorkSource](https://developer.android.com/reference/kotlin/android/os/WorkSource.html#)!`)` <br />                                                                                |
| open[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)   | [toString](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#toString())`()` <br />                                                                                                                                                                                                                |

|                                                                                            Protected methods                                                                                             ||
|----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| open[Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [finalize](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#finalize())`()` <br /> |

## Public methods

### acquire

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
open fun acquire(): Unit
```

Locks the Wi-Fi radio on until[release](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#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](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#release())will be required, regardless of the number of times that`acquire`is called.  

### isHeld

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
open fun isHeld(): Boolean
```

Checks whether this WifiLock is currently held.

|                                                               Return                                                               ||
|------------------------------------------------------------------------------------|------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | true if this WifiLock is held, false otherwise |

### release

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
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](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#acquire())), an exception is thrown. If this WifiLock is not reference-counted, the first call to`release`(after the radio was locked using[acquire](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#acquire())) will unlock the radio, and subsequent calls will be ignored.  

### setReferenceCounted

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
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](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#acquire())and[release](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#release()), and only allow the radio to sleep when every call to[acquire](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#acquire())has been balanced with a call to[release](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#release()). Non-reference-counted WifiLocks lock the radio whenever[acquire](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#acquire())is called and it is unlocked, and unlock the radio whenever[release](https://developer.android.com/reference/kotlin/android/net/wifi/WifiManager.WifiLock#release())is called and it is locked.

|                                                                      Parameters                                                                      ||
|--------------|----------------------------------------------------------------------------------------------------------------------------------------|
| `refCounted` | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html):true if this WifiLock should keep a reference count |

### setWorkSource

Added in[API level 9](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
open fun setWorkSource(ws: WorkSource!): Unit
```  

### toString

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
open fun toString(): String
```

|                                                          Return                                                          ||
|----------------------------------------------------------------------------------|----------------------------------------|
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | a string representation of the object. |

## Protected methods

### finalize

Added in[API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
protected open fun finalize(): Unit
```

|                         Exceptions                         ||
|-----------------------|-------------------------------------|
| `java.lang.Throwable` | the`Exception`raised by this method |