Jido.Messaging.Onboarding.Worker (Jido Messaging v1.0.0)

Runtime process for a single onboarding flow.

The worker restores persisted flow state, applies state-machine transitions, and persists changes when the flow advances.

Summary

Types

state()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

get_flow(pid, timeout \\ 5000)

Returns the current onboarding flow state from a worker.

start_link(opts)

Starts an onboarding worker registered by onboarding ID.

transition(pid, transition, metadata, opts \\ [], timeout \\ 5000)

Applies an onboarding transition and persists the updated flow.

whereis(instance_module, onboarding_id)

Returns the worker process for onboarding_id, if it is running.

Types

state()

@type state() :: %{
  instance_module: module(),
  onboarding_id: String.t(),
  flow: Jido.Messaging.Onboarding.Flow.t()
}

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

get_flow(pid, timeout \\ 5000)

@spec get_flow(pid(), timeout()) ::
  {:ok, Jido.Messaging.Onboarding.Flow.t()} | {:error, term()}

Returns the current onboarding flow state from a worker.

start_link(opts)

@spec start_link(keyword()) :: GenServer.on_start()

Starts an onboarding worker registered by onboarding ID.

transition(pid, transition, metadata, opts \\ [], timeout \\ 5000)

@spec transition(
  pid(),
  Jido.Messaging.Onboarding.StateMachine.transition(),
  map(),
  keyword(),
  timeout()
) ::
  {:ok,
   %{
     flow: Jido.Messaging.Onboarding.Flow.t(),
     transition: Jido.Messaging.Onboarding.StateMachine.transition_result()
   }}
  | {:error, term()}

Applies an onboarding transition and persists the updated flow.

whereis(instance_module, onboarding_id)

@spec whereis(module(), String.t()) :: pid() | nil

Returns the worker process for onboarding_id, if it is running.