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.

Note that just like with a regular Thread, start() must still be called.

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.

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.

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.