Added in API level 1

ConditionVariable


open class ConditionVariable
kotlin.Any
   ↳ android.os.ConditionVariable

Class that implements the condition variable locking paradigm.

This differs from the built-in java.lang.Object wait() and notify() in that this class contains the condition to wait on itself. That means open(), close() and block() are sticky. If open() is called before block(), block() will not block, and instead return immediately.

This class uses itself as the object to wait on, so if you wait() or notify() on a ConditionVariable, the results are undefined.

Summary

Public constructors

Create the ConditionVariable in the default closed state.

Create the ConditionVariable with the given state.

Public methods
open Unit

Block the current thread until the condition is opened.

open Boolean
block(timeoutMs: Long)

Block the current thread until the condition is opened or until timeoutMs milliseconds have passed.

open Unit

Reset the condition to the closed state.

open Unit

Open the condition, and release all threads that are blocked.

Public constructors

ConditionVariable

Added in API level 1
ConditionVariable()

Create the ConditionVariable in the default closed state.

ConditionVariable

Added in API level 1
ConditionVariable(state: Boolean)

Create the ConditionVariable with the given state.

Pass true for opened and false for closed.

Public methods

block

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

Block the current thread until the condition is opened.

If the condition is already opened, return immediately.

block

Added in API level 1
open fun block(timeoutMs: Long): Boolean

Block the current thread until the condition is opened or until timeoutMs milliseconds have passed.

If the condition is already opened, return immediately.

Parameters
timeoutMs Long: the maximum time to wait in milliseconds.
Return
Boolean true if the condition was opened, false if the call returns because of the timeout.

close

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

Reset the condition to the closed state.

Any threads that call block() will block until someone calls open.

open

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

Open the condition, and release all threads that are blocked.

Any threads that later approach block() will not block unless close() is called.