corda / net.corda.core.messaging / FlowProgressHandleImpl

FlowProgressHandleImpl

data class FlowProgressHandleImpl<A> : FlowProgressHandle<A>

Constructors

<init>

FlowProgressHandleImpl(id: StateMachineRunId, returnValue: CordaFuture<A>, progress: <ERROR CLASS><String>, stepsTreeIndexFeed: DataFeed<Int, Int>? = null, stepsTreeFeed: DataFeed<List<<ERROR CLASS><Int, String>>, List<<ERROR CLASS><Int, String>>>? = null)

Properties

id

val id: StateMachineRunId

The started state machine's ID.

progress

val progress: <ERROR CLASS><String>

The stream of progress tracker events.

returnValue

val returnValue: CordaFuture<A>

A CordaFuture of the flow's return value.

stepsTreeFeed

val stepsTreeFeed: DataFeed<List<<ERROR CLASS><Int, String>>, List<<ERROR CLASS><Int, String>>>?

DataFeed of current steps tree, see ProgressTracker

stepsTreeIndexFeed

val stepsTreeIndexFeed: DataFeed<Int, Int>?

DataFeed of current step in the steps tree, see ProgressTracker

Functions

close

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.

copy

fun copy(id: StateMachineRunId, returnValue: CordaFuture<A>, progress: <ERROR CLASS><String>): FlowProgressHandleImpl<A>

Extension Functions

contextLogger

fun Any.contextLogger(): <ERROR CLASS>

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