docs/net.corda.core.messaging/FlowProgressHandle

FlowProgressHandle

interface FlowProgressHandle<A> : FlowHandle<A>

FlowProgressHandle is a serialisable handle for the started flow, parameterised by the type of the flow's return value.

Inheritors

FlowProgressHandleImpl

Properties

abstract val id: StateMachineRunId

The started state machine's ID.

abstract val progress: <Error class: unknown class><String>

The stream of progress tracker events.

abstract val returnValue: CordaFuture<A>

A CordaFuture of the flow's return value.

abstract val stepsTreeFeed: DataFeed<List<<Error class: unknown class><Int, String>>, List<<Error class: unknown class><Int, String>>>?

DataFeed of current steps tree, see ProgressTracker

stepsTreeIndexFeed

abstract val stepsTreeIndexFeed: DataFeed<Int, Int>?

DataFeed of current step in the steps tree, see ProgressTracker

Functions

abstract 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.