SuperWorker.ConfigLoader.ConfigParser (SuperWorker v0.3.6)

View Source

This module is the main entry point for loading supervisor configurations. It reads configurations from the application environment, uses the Parser to validate and expand them, and the Bootstrap to start the supervisors.

Summary

Functions

load()

Loads all supervisor configurations defined in the application environment, except for the general :options key.

load_one(sup_id)

Loads and starts a single supervisor configuration by its ID from the application environment.

Functions

load()

@spec load() :: :ok

Loads all supervisor configurations defined in the application environment, except for the general :options key.

For each configuration found, it parses and starts a supervisor.

Example Configuration in config/config.exs:

config :super_worker,
  my_awesome_supervisor: [
    options: [
      strategy: :one_for_one
    ],
    groups: [
      # ... group definitions
    ]
  ]

load_one(sup_id)

@spec load_one(sup_id :: atom()) :: {:ok, pid()} | {:error, any()}

Loads and starts a single supervisor configuration by its ID from the application environment.