docs/net.corda.core.messaging/FlowProgressHandleImpl

FlowProgressHandleImpl

data class FlowProgressHandleImpl<A> constructor(val id: StateMachineRunId, val returnValue: CordaFuture<A>, val progress: <Error class: unknown class><String>, val stepsTreeIndexFeed: DataFeed<Int, Int>? = null, val stepsTreeFeed: DataFeed<List<<Error class: unknown class><Int, String>>, List<<Error class: unknown class><Int, String>>>? = null) : FlowProgressHandle<A>

Constructors

constructor(id: StateMachineRunId, returnValue: CordaFuture<A>, progress: <Error class: unknown class><String>, stepsTreeIndexFeed: DataFeed<Int, Int>? = null, stepsTreeFeed: DataFeed<List<<Error class: unknown class><Int, String>>, List<<Error class: unknown class><Int, String>>>? = null)

Properties

open override val id: StateMachineRunId

The started state machine's ID.

progress

open override val progress: <Error class: unknown class><String>

The stream of progress tracker events.

returnValue

open override val returnValue: CordaFuture<A>

A CordaFuture of the flow's return value.

stepsTreeFeed

open override val stepsTreeFeed: DataFeed<List<<Error class: unknown class><Int, String>>, List<<Error class: unknown class><Int, String>>>? = null

DataFeed of current steps tree, see ProgressTracker

stepsTreeIndexFeed

open override val stepsTreeIndexFeed: DataFeed<Int, Int>? = null

DataFeed of current step in the steps tree, see ProgressTracker

Functions

open override fun close()

Use this function for flows whose returnValue and progress are not going to be used or tracked, so as to free up server resources. Note that it won't really close if one subscribes on progress Observable, but then forgets to unsubscribe.

copy

fun copy(id: StateMachineRunId, returnValue: CordaFuture<A>, progress: <Error class: unknown class><String>): FlowProgressHandleImpl<A>