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

Copy Markdown View Source

Dynamic supervisor for onboarding workers partitioned by onboarding ID.

Summary

Functions

Returns a specification to start this module under a supervisor.

Returns the number of active onboarding workers for an instance.

Returns the worker for an onboarding flow, starting it when necessary.

Starts the dynamic supervisor for onboarding workers.

Starts or returns the worker for an onboarding flow.

Resolves the registered supervisor name for an instance module.

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

count_workers(instance_module)

@spec count_workers(module()) :: non_neg_integer()

Returns the number of active onboarding workers for an instance.

get_or_start_worker(instance_module, onboarding_id, opts \\ [])

@spec get_or_start_worker(module(), String.t(), keyword()) ::
  {:ok, pid()} | {:error, term()}

Returns the worker for an onboarding flow, starting it when necessary.

start_link(opts)

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

Starts the dynamic supervisor for onboarding workers.

start_worker(instance_module, onboarding_id, opts \\ [])

@spec start_worker(module(), String.t(), keyword()) :: {:ok, pid()} | {:error, term()}

Starts or returns the worker for an onboarding flow.

supervisor_name(instance_module)

@spec supervisor_name(module()) :: atom()

Resolves the registered supervisor name for an instance module.