Jizoku.Runtime.Journal.Cancellation (jizoku v0.4.0)

Copy Markdown View Source

Backward-compatible alias for journal cancellation commands.

New code should call Jizoku.Runtime.Journal.Commands.Cancellation. This module preserves the older runtime namespace for existing host integrations and tests.

Summary

Functions

Applies a normalized cancellation signal at the journal command boundary.

Requests cancellation for a journal-backed workflow run.

Types

cancel_error()

Functions

apply_signal(signal, opts)

@spec apply_signal(
  Jizoku.Runtime.Signal.t(),
  keyword()
) :: {:ok, Jizoku.ReadModel.Inspection.Snapshot.t()} | {:error, cancel_error()}

Applies a normalized cancellation signal at the journal command boundary.

cancel(run_id, opts \\ [])

@spec cancel(
  String.t(),
  keyword()
) :: {:ok, Jizoku.ReadModel.Inspection.Snapshot.t()} | {:error, cancel_error()}

Requests cancellation for a journal-backed workflow run.