FlowProgressHandle
Keywords: net.corda.core.messaging.FlowProgressHandle interface
Date: 2023-09-18

net.corda.core.messaging

## Interface FlowProgressHandle<A>

- All Superinterfaces:
    FlowHandle<A>
  All Known Implementing Classes:
    FlowProgressHandleImpl

      public FlowProgressHandle<A>
      extends FlowHandle<A>

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

  See Also:
    `interface FlowProgressHandle`

- - ### Constructor Detail

    - #### FlowProgressHandle

          public FlowProgressHandle()

  - ### Method Detail

    - #### getProgress

          @NotNull
          rx.Observable<java.lang.String> getProgress()

      The stream of progress tracker events.

    - #### getStepsTreeIndexFeed

          @Nullable
          DataFeed<java.lang.Integer,java.lang.Integer> getStepsTreeIndexFeed()

      `class DataFeed` of current step in the steps tree, see ProgressTracker

      See Also:
        `class DataFeed`, ProgressTracker

    - #### getStepsTreeFeed

          @Nullable
          DataFeed<java.util.List,java.util.List> getStepsTreeFeed()

      `class DataFeed` of current steps tree, see ProgressTracker

      See Also:
        `class DataFeed`, ProgressTracker

    - #### close

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