Oban.Config (Oban v2.7.2) View Source

The Config struct validates and encapsulates Oban instance state.

Options passed to Oban.start_link/1 are validated and stored in a config struct. Internal modules and plugins are always passed the config with a :conf key.

Link to this section Summary

Link to this section Types

Specs

option() :: {:name, module()} | {:conf, t()}

Specs

t() :: %Oban.Config{
  circuit_backoff: timeout(),
  dispatch_cooldown: pos_integer(),
  engine: module(),
  get_dynamic_repo: nil | (() -> pid() | atom()),
  log: false | Logger.level(),
  name: Oban.name(),
  node: binary(),
  notifier: module(),
  plugins: [module() | {module() | Keyword.t()}],
  prefix: binary(),
  queues: [{atom(), Keyword.t()}],
  repo: module(),
  shutdown_grace_period: timeout()
}