suparnatural-concurrency/com.suparnatural.core.concurrency/NativeFuture

NativeFuture

A NativeFuture returns an instance of platform specific Future wrapped in a common API. Calling NativeFuture.await will wait until the result is available.

The platform specific implementations have their own constructors which wrap the native Future API.

class NativeFuture<T> : Future<T>

class NativeFuture<T>(future: <ERROR CLASS><T>) : Future<T>

Functions

await

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

override fun await(): T

open override 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.

override var isCompleted: Boolean

isCompleted

ios

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

open override var isCompleted: Boolean