litho-core/com.facebook.litho/TreeFuture

TreeFuture

abstract class TreeFuture<T : PotentiallyPartialResult>(treeId: Int, isInterruptionEnabled: Boolean)

Base class that wraps a FutureTask to allow calculating the same result across threads.

Inheritors

LayoutTreeFuture

ResolveTreeFuture

Constructors

constructor(treeId: Int, isInterruptionEnabled: Boolean)

Types

object Companion

FutureExecutionListener

interface FutureExecutionListener

FutureExecutionType

enum FutureExecutionType : Enum<TreeFuture.FutureExecutionType>

enum FutureState : Enum<TreeFuture.FutureState>

TreeFutureResult

class TreeFutureResult<T : PotentiallyPartialResult>

Holder class for tree-future results. When the contained result is null, the string message will be populated with the result for it being null.

Properties

isInterruptible

val isInterruptible: Boolean

true if this future is interruptible.

isInterruptRequested

val isInterruptRequested: Boolean

true if an interrupt has been requested on this future, indicating the calculation must be resumed on the main-thread.

var isReleased: Boolean

Returns true if this future has been released.

val waitingCount: Int

Functions

abstract fun getDescription(): String

Returns a String that gives a textual representation of the type of future it is.

abstract fun getVersion(): Int

Returns an integer that identifies uniquely the version of this TreeFuture.

abstract fun isEquivalentTo(that: TreeFuture<*>?): Boolean

Returns true if the provided TreeFuture is equivalent to this one.

@VisibleForTesting(otherwise = 3)

Releases this TreeFuture

@VisibleForTesting(otherwise = 3)

fun runAndGet(source: Int, type: TreeFuture.FutureExecutionType? = null): TreeFuture.TreeFutureResult<T>

Synchronously executes the future task, ensuring the result is calculated, and resumed on the main thread if it is interrupted while running on a background thread.

tryRegisterForResponse

fun tryRegisterForResponse(waitingFromSyncLayout: Boolean): Boolean

We want to prevent a sync layout in the background from waiting on an interrupted layout (which will return a null result). To handle this, we make sure that a sync bg layout can only wait on a NON_INTERRUPTIBLE future, and that a NON_INTERRUPTIBLE future can't be interrupted.

unregisterForResponse

fun unregisterForResponse()