KState-Saga/ca.acendas.kstate.saga.dsl/HaltScope

HaltScope

class HaltScope<C, R, S>(val step: TypedValue, val context: C, val state: S, val effectKey: String?)

Receiver scope for before.each(step) { } lambdas.

Provides access to the current StepPhase.Before phase data and the halt keyword — so halt because "reason" is syntactically available directly inside the block without any import.

Parameters

The context type.

The result type.

The state type.

Constructors

HaltScope

constructor(step: TypedValue, context: C, state: S, effectKey: String?)

Properties

context

val context: C

The saga context for the current execution.

effectKey

val effectKey: String?

Pre-computed F004 effect-key, or null if the step declares none.

halt

val halt: HaltKeyword

Sentinel that enables halt because "reason" inside a before.each(step) { } block.

state

val state: S

Current saga state snapshot.

step

val step: TypedValue

Step identifier for the step about to execute.