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

Package-level declarations

Types

AfterEachScope

class AfterEachScope<C, R, S>(val step: TypedValue, val state: S)

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

AfterHaltKeyword

object AfterHaltKeyword

Sentinel providing halt because "reason" inside after.each(step) { }.

AfterPhase

class AfterPhase<C, R>(builder: SagaBuilder<C, R>)

Intermediate produced by val SagaBuilder.after.

AuditCommand

class AuditCommand

Intermediate value produced by saga audit "id".

AuditConfigurer

class AuditConfigurer<C, R>(builder: SagaBuilder<C, R>)

Entry point for the keep audit in journal DSL.

AuditKeyword

class AuditKeyword<C, R>(builder: SagaBuilder<C, R>)

Intermediate DSL node representing the audit keyword.

AuditRange

class AuditRange

Intermediate value produced by (saga audit "id").from(a).

AuditResult

sealed interface AuditResult

DSL-layer view of ca.acendas.kstate.saga.journal.VerifyResult returned by the saga audit "id" DSL.

BeforePhase

class BeforePhase<C, R>(builder: SagaBuilder<C, R>)

Intermediate produced by val SagaBuilder.before.

CorruptJournal

typealias CorruptJournal = ResumeOutcome.CorruptJournal

Unprefixed alias for ResumeOutcome.CorruptJournal.

HaltKeyword

object HaltKeyword

Singleton object that provides the because infix syntax.

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.

Incomplete

typealias Incomplete = AuditResult.Incomplete

Unprefixed alias for AuditResult.Incomplete.

Indeterminate

typealias Indeterminate<S> = ResumeOutcome.Indeterminate<S>

Unprefixed alias for ResumeOutcome.Indeterminate.

Intact

typealias Intact = AuditResult.Intact

Unprefixed alias for AuditResult.Intact.

NotFound

typealias NotFound = ResumeOutcome.NotFound

Unprefixed alias for ResumeOutcome.NotFound.

per

object per

Sentinel object that enables the once per { ctx -> key } infix syntax.

PerKey

class PerKey<C>(val block: suspend (C) -> String)

Captures an effect-key lambda for use with the once per { } DSL syntax.

ProtectConfigurer

class ProtectConfigurer<C, R>(builder: SagaBuilder<C, R>)

Intermediate receiver returned by the protect DSL property.

Resumed

typealias Resumed<R, S> = ResumeOutcome.Resumed<R, S>

Unprefixed alias for ResumeOutcome.Resumed.

ResumeId

class ResumeId<C, R, S : Any>(executor: StatefulSagaExecutor<C, R, S>, id: String)

Intermediate value produced by saga resume "id".

step

object step

Sentinel that marks the each(step, …) position in the interceptor DSL chain.

Tampered

typealias Tampered = AuditResult.Tampered

Unprefixed alias for AuditResult.Tampered.

tamperEvidence

object tamperEvidence : TamperEvidenceScheme

Singleton verb object that reads as natural English: protect with tamperEvidence.

TamperEvidenceScheme

sealed interface TamperEvidenceScheme

Sealed marker for tamper-evidence schemes.

Unavailable

typealias Unavailable = AuditResult.Unavailable

Unprefixed alias for AuditResult.Unavailable.

Properties

after

val <C, R> SagaBuilder<C, R>.after: AfterPhase<C, R>

Entry point for after.each(step) { … } on SagaBuilder.

before

val <C, R> SagaBuilder<C, R>.before: BeforePhase<C, R>

Entry point for before.each(step) { … } on SagaBuilder.

keep

val <C, R> SagaBuilder<C, R>.keep: AuditConfigurer<C, R>

Entry point for the keep audit in journal conversational DSL (F006 AC1).

protect

val <C, R> SagaBuilder<C, R>.protect: ProtectConfigurer<C, R>

Entry point for tamper-evidence configuration.

Functions

audit

infix fun SagaExecutor<*, *>.audit(id: String): AuditCommand

Entry point for all audit DSL forms.

each

fun <C, R> AfterPhase<C, R>.each(keyword: step, block: suspend AfterEachScope<C, R, Unit>.(R) -> Unit)

Registers a SagaInterceptor for after.each(step) { … } usage.

fun <C, R> BeforePhase<C, R>.each(keyword: step, block: suspend HaltScope<C, R, Unit>.(StepPhase.Before<C, R, Unit>) -> Unit)

Registers a SagaInterceptor for before.each(step) { … } usage.

execute

suspend fun AuditCommand.execute(): AuditResult

Executes the full-chain audit (seq 0 to Long.MAX_VALUE) for the run identified in this AuditCommand.

from

infix fun AuditCommand.from(seq: Long): AuditRange

First half of the saga audit "id" from a to b ranged form.

infix inline fun <C, R, P : Any> AuditKeyword<C, R>.in(journal: SagaJournal<P>)

Supplies the journal and resolves the codec for the keep audit in journal chain.

once

infix fun <C, R> SagaStepConfiguration<C, R>.once(key: PerKey<C>): SagaStepConfiguration<C, R>

Declares the F004 effect-key on a step using the conversational once per { } syntax.

resume

infix fun <C, R, S : Any> StatefulSagaExecutor<C, R, S>.resume(id: String): ResumeId<C, R, S>

First half of the saga resume "id" with ctx DSL chain.

infix suspend fun AuditRange.to(toSeq: Long): AuditResult

Second half of the saga audit "id" from a to b ranged form.

with

infix suspend fun <C, R, S : Any> ResumeId<C, R, S>.with(ctx: C): ResumeOutcome<R, S>

Second half of the saga resume "id" with ctx DSL chain.