litho-core/com.facebook.litho/TreeFuture

TreeFuture

abstract class TreeFuture<T : PotentiallyPartialResult?>

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

Inheritors

Constructors

Link copied to clipboard
constructor(treeId: Int, isInterruptionEnabled: Boolean)

Types

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open class TreeFutureResult<T : PotentiallyPartialResult?>
Holder class for tree-future results.

Properties

Link copied to clipboard
val FUTURE_RESULT_NULL_REASON_RELEASED: String = "TreeFuture released"
val FUTURE_RESULT_NULL_REASON_RESUME_NON_MAIN_THREAD: String = "Resuming partial result skipped due to not being on main-thread"
val FUTURE_RESULT_NULL_REASON_SYNC_RESULT_NON_MAIN_THREAD: String = "Waiting for sync result from non-main-thread"

Functions

Link copied to clipboard
abstract fun getDescription(): String
Returns a String that gives a textual representation of the type of future it is.
Link copied to clipboard
abstract fun getVersion(): Int
Returns an integer that identifies uniquely the version of this TreeFuture.
Link copied to clipboard
open fun getWaitingCount(): Int
Link copied to clipboard
abstract fun isEquivalentTo(that: TreeFuture): Boolean
Returns true if the provided TreeFuture is equivalent to this one.
Link copied to clipboard
@VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)
open fun release()
Releases this TreeFuture
Link copied to clipboard
@VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)
open fun <T : PotentiallyPartialResult?, F : TreeFuture<T>?> trackAndRunTreeFuture(treeFuture: F, futureList: List<F>, source: Int, mutex: Any, @Nullable futureExecutionListener: TreeFuture.FutureExecutionListener): TreeFuture.TreeFutureResult<T>
Given a provided tree-future, this method will track it via a given list, and run it.