multiplatformx-api/org.brightify.hyperdrive.multiplatformx/LifecycleGraph

LifecycleGraph

sealed class LifecycleGraph

This class is NOT thread-safe. Attaching and detaching from scopes should be performed from the main thread.

Types

Node

class Node(owner: Any) : LifecycleGraph

Root

class Root(owner: Any?) : LifecycleGraph

Functions

addChild

fun addChild(child: LifecycleGraph.Node)

Adds child as a dependent lifecycle sharing the same scope and attachment status as this instance.

addChildren

fun addChildren(childrenToAdd: Collection<LifecycleGraph.Node>)

addListener

fun addListener(listener: LifecycleListener): CancellationToken

dumpTree

fun dumpTree(): String

hasChild

fun hasChild(child: LifecycleGraph.Node): Boolean

onDidAttach

fun onDidAttach(validity: LifecycleListener.Validity = LifecycleListener.Validity.Infinite, listener: () -> Unit): CancellationToken

Registers listener for the DidAttach event.

onDidDetach

fun onDidDetach(validity: LifecycleListener.Validity = LifecycleListener.Validity.Infinite, listener: () -> Unit): CancellationToken

Registers listener for the DidDetach event.

onWillAttach

fun onWillAttach(validity: LifecycleListener.Validity = LifecycleListener.Validity.Infinite, listener: () -> Unit): CancellationToken

Registers listener for the WillAttach event.

onWillDetach

fun onWillDetach(validity: LifecycleListener.Validity = LifecycleListener.Validity.Infinite, listener: () -> Unit): CancellationToken

Registers listener for the WillDetach event.

removeChild

fun removeChild(child: LifecycleGraph.Node)

removeChildren

fun removeChildren(childrenToRemove: Collection<Lifecycle>)

removeListener

fun removeListener(listener: LifecycleListener)

runOnceIfAttached

fun runOnceIfAttached(runner: suspend CoroutineScope.() -> Unit): Boolean

Launches runner right away if attached, does nothing otherwise.

topMostNode

fun topMostNode(): LifecycleGraph

whileAttached

fun whileAttached(runner: suspend CoroutineScope.() -> Unit): CancellationToken

Registers runner to be launched each time this lifecycle is attached to a scope and cancelled once detached.

Properties

debugDescription

val debugDescription: String

isAttached

val isAttached: Boolean

Inheritors

Root

Node