corda.flow

Configuration schema for the flow section.

• event - Settings for external events within a flow.
  • maxRetries - The maximum number of times Corda retries a request before returning an exception.
    Default value: 5
    Minimum value: 0
    Maximum value: 2147483647
  • messageResendWindow - The length of time in milliseconds that Corda waits before resending unprocessed external events.
    Default value: 60000
    Minimum value: 1000
    Maximum value: 2147483647

• processing - Settings for flow pipeline processing.
  • cleanupTime - The length of time in milliseconds that the flow mapper holds onto the state for a flow that has finished. When the start flow state is removed, clientRequestIds will be available for reuse within the flow mapper. This value should be set lower than the rest config field 'flowStatusCleanupTimeMs'.
    Default value: 600000
    Minimum value: 1000
    Maximum value: 2147483647
  • maxFlowSleepDuration - Deprecated. The maximum delay in milliseconds before Corda schedules a periodic wake-up.
    Default value: 900000
    Minimum value: 1000
    Maximum value: 2147483647
  • maxIdleTime - The maximum time, in milliseconds, a Flow can be in 'RUNNING' state without receiving any updates. Once this time has elapsed, Corda will automatically mark the flow as 'FAILED' and clean up any associated state.
    Default value: 1800000
    Minimum value: 60000
    Maximum value: 31557600000
  • maxRetryAttempts - The maximum number of times Corda retries a transient error before failing the flow. A value of zero disables retries.
    Default value: 5
    Minimum value: 0
    Maximum value: 1000
  • maxRetryDelay - The maximum delay in milliseconds before Corda schedules a retry.
    Default value: 16000
    Minimum value: 1000
    Maximum value: 2147483647
  • maxRetryWindowDuration - The duration in milliseconds after a transient error that Corda retries a flow before failing it. A value of zero disables retries.
    Default value: 300000
    Minimum value: 0
    Maximum value: 2147483647
  • poolSize - The size of the flow event processing pool size.
    Default value: 8
    Minimum value: 1
    Maximum value: 2147483647

• session - Settings for flow sessions.
  • cleanupTime - The length of time in milliseconds that the flow mapper holds onto its state for a session after the session has finished. This value should be at least 2 times larger than the session.p2pTTL
    Default value: 600000
    Minimum value: 10000
    Maximum value: 2147483647
  • heartbeatTimeout - The length of time in milliseconds that Corda waits when no message has been received from a counterparty before causing the session to error. This should be set at least 2 times larger than session.messageResendWindow.
    Default value: 1800000
    Minimum value: 1000
    Maximum value: 2147483647
  • messageResendWindow - The length of time in milliseconds that Corda waits before resending unacknowledged flow session messages.
    Default value: 120000
    Minimum value: 1000
    Maximum value: 2147483647
  • missingCounterpartyTimeout - The length of time in milliseconds to wait when the counterparty can't be found in a member lookup before causing the session to error
    Default value: 300000
    Minimum value: 1000
    Maximum value: 2147483647
  • p2pTTL - The TTL set in milliseconds. This is added to the current time and set on messages passed to the P2P layer to send to a counterparty. Messages received with a TTL timestamp set in the past will be discarded.
    Default value: 300000
    Minimum value: 10000
    Maximum value: 2147483647
  • timeout - The length of time in milliseconds that Corda waits when no message has been received from a counterparty before causing the session to error. This value may be overridden by a flow specific timeout set via the FlowMessaging API.
    Default value: 1800000
    Minimum value: 1000
    Maximum value: 2147483647