Added in API level 1

HandlerThread


open class HandlerThread : Thread
kotlin.Any
   ↳ java.lang.Thread
   ↳ android.os.HandlerThread

A Thread that has a Looper. The Looper can then be used to create Handlers. Just like with a regular Thread, start() must still be called.

Use this class only if you must work with the Handler API and need a Thread to do the handling on that is not an existing Looper thread, such as android.os.Looper#getMainLooper(). Otherwise, prefer java.util.concurrent.Executor or , or Kotlin coroutines.

Note that many APIs that required a Handler in older SDK versions offer a newer alternative that accepts an java.util.concurrent.Executor instead. Always prefer to use the newer API if available.

Alternatives to HandlerThread

java.util.concurrent.Executors offer more flexibility with regards to threading. Work submitted to an java.util.concurrent.Executor can be set to run on another thread, on one of several threads from a static or dynamic pool, or on the caller's thread, depending on your needs.

{link @link java.util.concurrent.Executor} offers a simpler API that is easier to use compared to Handler. {link @link java.util.concurrent.ExecutorService} offers the richer API, which you can use to monitor task status, cancel tasks, propagate exceptions, and chain multiple pending tasks.

{link @link java.util.concurrent.Executors} is a factory for various s that meet common concurrency needs. These s use work queues that offer better concurrency and reduced contention than HandlerThread.

On Kotlin, coroutines may be used to handle concurrency.

Common HandlerThread performance issues

Apps that use HandlerThread may encounter the following performance issues:

  • Excessive thread creation: A HandlerThread is a java.lang.Thread. Every system thread costs some resident memory, whether it is working or if it's idle. If your app has a large number of HandlerThreads each dedicated to a single type of task, rather than for instance a java.util.concurrent.ThreadPoolExecutor that can grow and shrink in size according to demand, then the additional idle HandlerThreads will be wasting memory.
  • Lock contention: HandlerThread uses a Looper which in turn uses a MessageQueue. MessageQueue uses a single lock to synchronize access to its underlying queue. Any threads attempting to enqueue messages at the same time, and the HandlerThread itself when attempting to dequeue the next message to handle, will block each other.
  • Priority inversion: A high-priority HandlerThread can become blocked by a lower-priority thread, for instance if the former is trying to enqueue a message while the latter is trying to dequeue the next message to handle, or vice versa.
The best way to avoid these issues is to use java.util.concurrent.Executors or Kotlin coroutines instead of HandlerThread.

Summary

Inherited constants
Public constructors

HandlerThread(name: String!, priority: Int)

Constructs a HandlerThread.

Public methods
open Looper!

This method returns the Looper associated with this thread.

open Int

Returns the identifier of this thread.

open Boolean

Quits the handler thread's looper.

open Boolean

Quits the handler thread's looper safely.

open Unit
run()

Protected methods
open Unit

Call back method that can be explicitly overridden if needed to execute some setup before Looper loops.

Inherited functions

Public constructors

HandlerThread

Added in API level 1
HandlerThread(name: String!)

HandlerThread

Added in API level 1
HandlerThread(
    name: String!,
    priority: Int)

Constructs a HandlerThread.

Parameters
name String!:
priority Int: The priority to run the thread at. The value supplied must be from android.os.Process and not from java.lang.Thread.

Public methods

getLooper

Added in API level 1
open fun getLooper(): Looper!

This method returns the Looper associated with this thread. If this thread not been started or for any reason isAlive() returns false, this method will return null. If this thread has been started, this method will block until the looper has been initialized.

Return
Looper! The looper.

getThreadId

Added in API level 1
open fun getThreadId(): Int

Returns the identifier of this thread. See Process.myTid().

quit

Added in API level 5
open fun quit(): Boolean

Quits the handler thread's looper.

Causes the handler thread's looper to terminate without processing any more messages in the message queue.

Any attempt to post messages to the queue after the looper is asked to quit will fail. For example, the Handler.sendMessage(Message) method will return false.

If quit or quitSafely is called multiple times, the first call will have an effect and the subsequent calls will be no-ops.

Using this method may be unsafe because some messages may not be delivered before the looper terminates. Consider using quitSafely instead to ensure that all pending work is completed in an orderly manner.

Return
Boolean True if the looper looper has been asked to quit or false if the thread had not yet started running.

See Also

quitSafely

Added in API level 18
open fun quitSafely(): Boolean

Quits the handler thread's looper safely.

Causes the handler thread's looper to terminate as soon as all remaining messages in the message queue that are already due to be delivered have been handled. Pending delayed messages with due times in the future will not be delivered.

Any attempt to post messages to the queue after the looper is asked to quit will fail. For example, the Handler.sendMessage(Message) method will return false.

If the thread has not been started or has finished (that is if getLooper returns null), then false is returned. Otherwise the looper is asked to quit and true is returned.

If quit or quitSafely is called multiple times, the first call will have an effect and the subsequent calls will be no-ops.

Return
Boolean True if the looper looper has been asked to quit or false if the thread had not yet started running.

run

Added in API level 1
open fun run(): Unit

Protected methods

onLooperPrepared

Added in API level 1
protected open fun onLooperPrepared(): Unit

Call back method that can be explicitly overridden if needed to execute some setup before Looper loops.