corda / net.corda.core.messaging / FlowHandle

FlowHandle

@DoNotImplement interface FlowHandle<A> : AutoCloseable

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

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 is not going to be used, so as to free up server resources.

Extension Functions

contextLogger

fun Any.contextLogger(): Logger

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

Inheritors

FlowHandleImpl

data class FlowHandleImpl<A> : FlowHandle<A>

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.