guava-utils/com.pambrose.common.concurrent/BooleanMonitor

BooleanMonitor

class BooleanMonitor(initValue: Boolean) : GenericMonitor

A GenericMonitor implementation backed by an atomic boolean value.

Threads can block until the value becomes true or false using the inherited waitUntilTrue and waitUntilFalse methods from GenericMonitor.

Parameters

initValue

the initial boolean value.

Constructors

BooleanMonitor

constructor(initValue: Boolean)

Types

Companion

object Companion

Properties

monitorSatisfied

open override val monitorSatisfied: Boolean

Whether the monitor's condition is currently satisfied. Implemented by subclasses.

Functions

get

fun get(): Boolean

Returns the current boolean value.

set

fun set(value: Boolean)

Sets the boolean value in a thread-safe manner, entering and leaving the monitor.

toString

open override fun toString(): String

waitUntil

fun waitUntil(value: Boolean)

Blocks indefinitely until the condition matches value.

fun waitUntil(value: Boolean, waitTime: Duration): Boolean

Blocks until the condition matches value or the timeout expires.

waitUntilFalse

fun waitUntilFalse()

Blocks the current thread until monitorSatisfied returns false. This method is not interruptible.

fun waitUntilFalse(waitTime: Duration): Boolean

Blocks the current thread until monitorSatisfied returns false or the timeout expires. This method is not interruptible.

fun waitUntilFalse(timeout: Duration, block: MonitorAction): Boolean

Repeatedly waits for the condition to become false, invoking block on each timeout.

fun waitUntilFalse(timeout: Duration, maxWait: Duration, block: MonitorAction?): Boolean

Repeatedly waits for the condition to become false, invoking block on each timeout, up to an overall maximum wait duration.

waitUntilTrue

fun waitUntilTrue()

Blocks the current thread until monitorSatisfied returns true. This method is not interruptible.

fun waitUntilTrue(waitTime: Duration): Boolean

Blocks the current thread until monitorSatisfied returns true or the timeout expires. This method is not interruptible.

fun waitUntilTrue(timeout: Duration, block: MonitorAction): Boolean

Repeatedly waits for the condition to become true, invoking block on each timeout.

fun waitUntilTrue(timeout: Duration, maxWait: Duration, block: MonitorAction?): Boolean

Repeatedly waits for the condition to become true, invoking block on each timeout, up to an overall maximum wait duration.

waitUntilTrueWithInterruption

fun waitUntilTrueWithInterruption()

Blocks the current thread until monitorSatisfied returns true. This method can be interrupted.

fun waitUntilTrueWithInterruption(waitTime: Duration): Boolean

Blocks the current thread until monitorSatisfied returns true or the timeout expires. This method can be interrupted.

fun waitUntilTrueWithInterruption(timeout: Duration, block: MonitorAction): Boolean

Repeatedly waits (interruptibly) for the condition to become true, invoking block on each timeout.

fun waitUntilTrueWithInterruption(timeout: Duration, maxWait: Duration, block: MonitorAction?): Boolean

Repeatedly waits (interruptibly) for the condition to become true, invoking block on each timeout, up to an overall maximum wait duration.