suparnatural-concurrency/com.suparnatural.core.concurrency/Future

Future

A Future defers the resolution of a value to the future. The value can be consumed by calling Future.await method which is expected to block the current thread. Therefore, never call Future.await on the same thread as it will result in a dead lock.

interface Future<T>

Functions

await

common

Consume the future value in code as input. This method may or may not block the calling thread depending upon the implementation.

Examples

val future: Future<T> = // some api which returns a Future<T>
val value: R = future.await() // blocks until future completes

abstract fun await(): T

equals

common

open operator override fun equals(other: Any?): Boolean

hashCode

common

open override fun hashCode(): Int

toString

common

open override fun toString(): String

Properties

isCompleted

common

Returns true if the future has completed and is ready to await.

abstract var isCompleted: Boolean

Inheritors

JobFuture

common

ValueFuture

common

NativeFuture

DeferredFuture

ios