corda / 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.

Properties

progress

abstract val progress: Observable<String>

The stream of progress tracker events.

stepsTreeFeed

abstract val stepsTreeFeed: DataFeed<List<Pair<Int, String>>, List<Pair<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

Inherited Properties

id

abstract val id: StateMachineRunId

The started state machine's ID.

returnValue

abstract val returnValue: CordaFuture<A>

A CordaFuture of the flow's return value.

Functions

close

abstract fun close(): Unit

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.

Extension Functions

contextLogger

fun Any.contextLogger(): Logger

When called from a companion object, returns the logger for the enclosing class.

Inheritors

FlowProgressHandleImpl

data class FlowProgressHandleImpl<A> : FlowProgressHandle<A>