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

The stream of progress tracker events.

abstract val progress: Observable<String>

stepsTreeFeed

DataFeed of current steps tree, see ProgressTracker

abstract val stepsTreeFeed: DataFeed<List<Pair<Int, String>>, List<Pair<Int, String>>>?

stepsTreeIndexFeed

DataFeed of current step in the steps tree, see ProgressTracker

abstract val stepsTreeIndexFeed: DataFeed<Int, Int>?

Functions

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.

abstract fun close(): Unit

Inheritors

FlowProgressHandleImpl

data class FlowProgressHandleImpl<A> : FlowProgressHandle<A>