Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Methods](https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#pubmethods) \| [Protected Methods](https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#promethods) \| [Inherited Methods](https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#inhmethods)

# WifiManager.WifiLock

*** ** * ** ***

` public class WifiManager.WifiLock `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.net.wifi.WifiManager.WifiLock |

<br />

*** ** * ** ***

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 ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#acquire()() ` Locks the Wi-Fi radio on until `https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#release()` is called. |
| ` boolean` | ` https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#isHeld()() ` Checks whether this WifiLock is currently held. |
| ` void` | ` https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#release()() ` Unlocks the Wi-Fi radio, allowing it to turn off when the device is idle. |
| ` void` | ` https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#setReferenceCounted(boolean)(boolean refCounted) ` Controls whether this is a reference-counted or non-reference-counted WifiLock. |
| ` void` | ` https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#setWorkSource(android.os.WorkSource)(https://developer.android.com/reference/android/os/WorkSource ws) ` |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#toString()() ` Returns a string representation of the object. |

| ### Protected methods ||
|---|---|
| ` void` | ` https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Public methods

### acquire

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

```
public void acquire ()
```

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

<br />

### isHeld

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

```
public boolean isHeld ()
```

Checks whether this WifiLock is currently held.

<br />

| Returns ||
|---|---|
| `boolean` | true if this WifiLock is held, false otherwise <br /> |

### release

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

```
public void release ()
```

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 `https://developer.android.com/reference/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 `https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#acquire()`) will unlock the radio, and subsequent calls will be ignored.

<br />

### setReferenceCounted

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

```
public void setReferenceCounted (boolean refCounted)
```

Controls whether this is a reference-counted or non-reference-counted WifiLock. Reference-counted WifiLocks keep track of the number of calls to `https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#acquire()` and `https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#release()`, and only allow the radio to sleep when every call to `https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#acquire()` has been balanced with a call to `https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#release()`. Non-reference-counted WifiLocks lock the radio whenever `https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#acquire()` is called and it is unlocked, and unlock the radio whenever `https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock#release()` is called and it is locked.

<br />

| Parameters ||
|---|---|
| `refCounted` | `boolean`: true if this WifiLock should keep a reference count <br /> |

### setWorkSource

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

```
public void setWorkSource (WorkSource ws)
```

<br />

<br />

| Parameters ||
|---|---|
| `ws` | `WorkSource` <br /> |

### toString

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

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

## Protected methods

### finalize

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

```
protected void finalize ()
```

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the `finalize` method to dispose of system resources or to perform other cleanup.

The general contract of `finalize` is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The `finalize` method may take any action, including making this object available again to other threads; the usual purpose of `finalize`, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The `finalize` method of class `Object` performs no special action; it simply returns normally. Subclasses of `Object` may override this definition.

The Java programming language does not guarantee which thread will invoke the `finalize` method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the `finalize` method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The `finalize` method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the `finalize` method causes the finalization of this object to be halted, but is otherwise ignored.

<br />

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/Throwable` |   |