litho-core/com.facebook.litho/LayoutTreeFuture

LayoutTreeFuture

class LayoutTreeFuture(resolveResult: ResolveResult, currentLayoutState: LayoutState?, diffTreeRoot: DiffNode?, perfEvent: PerfEvent?, widthSpec: Int, heightSpec: Int, treeId: Int, version: Int, source: Int) : TreeFuture<LayoutState>

Constructors

LayoutTreeFuture

constructor(resolveResult: ResolveResult, currentLayoutState: LayoutState?, diffTreeRoot: DiffNode?, perfEvent: PerfEvent?, widthSpec: Int, heightSpec: Int, treeId: Int, version: Int, source: Int)

Types

Companion

object Companion

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.

isReleased

@Volatile

var isReleased: Boolean

Returns true if this future has been released.

waitingCount

val waitingCount: Int

Functions

getDescription

open override fun getDescription(): String

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

getVersion

open override fun getVersion(): Int

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

isEquivalentTo

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

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

release

@VisibleForTesting(otherwise = 3)

@Synchronized

fun release()

Releases this TreeFuture

runAndGet

@VisibleForTesting(otherwise = 3)

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

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()