Yggdrasil v4.1.2 Yggdrasil.Settings View Source

This module defines the available settings for Yggdrasil.

Link to this section Summary

Functions

Same as Elixir.Skogsra.yggdrasil_module_registry/1 but fails on error

Same as Elixir.Skogsra.yggdrasil_process_registry/1 but fails on error

Yggdrasil publisher options. This options are for :poolboy. Defaults to [size: 5, max_overflow: 10]

Same as Elixir.Skogsra.yggdrasil_publisher_options/1 but fails on error

Pub-sub adapter to use for channels. Default value is Phoenix.PubSub.PG2

Same as Elixir.Skogsra.yggdrasil_pubsub_adapter/1 but fails on error

Pub-sub name. By default is Yggdrasil.PubSub

Same as Elixir.Skogsra.yggdrasil_pubsub_name/1 but fails on error

Pub-sub options. By default are [pool_size: 1]

Same as Elixir.Skogsra.yggdrasil_pubsub_options/1 but fails on error

Link to this section Functions

Link to this function yggdrasil_module_registry(namespace \\ nil, type \\ :run) View Source
yggdrasil_module_registry(
  namespace :: atom(),
  type :: :run | :reload | :system | :config
) :: {:ok, term()} | {:error, term()}

Module registry table name.

config :yggdrasil,
  module_registry: :yggdrasil_registry
Link to this function yggdrasil_module_registry!(namespace \\ nil) View Source
yggdrasil_module_registry!(namespace :: atom()) ::
  {:ok, term()} | {:error, term()}

Same as Elixir.Skogsra.yggdrasil_module_registry/1 but fails on error.

Link to this function yggdrasil_process_registry(namespace \\ nil, type \\ :run) View Source
yggdrasil_process_registry(
  namespace :: atom(),
  type :: :run | :reload | :system | :config
) :: {:ok, term()} | {:error, term()}

Process registry.

config :yggdrasil,
  process_registry: ExReg
Link to this function yggdrasil_process_registry!(namespace \\ nil) View Source
yggdrasil_process_registry!(namespace :: atom()) ::
  {:ok, term()} | {:error, term()}

Same as Elixir.Skogsra.yggdrasil_process_registry/1 but fails on error.

Link to this function yggdrasil_publisher_options(namespace \\ nil, type \\ :run) View Source
yggdrasil_publisher_options(
  namespace :: atom(),
  type :: :run | :reload | :system | :config
) :: {:ok, term()} | {:error, term()}

Yggdrasil publisher options. This options are for :poolboy. Defaults to [size: 5, max_overflow: 10].

config :yggdrasil,
  publisher_options: [size: 5, max_overflow: 10]
Link to this function yggdrasil_publisher_options!(namespace \\ nil) View Source
yggdrasil_publisher_options!(namespace :: atom()) ::
  {:ok, term()} | {:error, term()}

Same as Elixir.Skogsra.yggdrasil_publisher_options/1 but fails on error.

Link to this function yggdrasil_pubsub_adapter(namespace \\ nil, type \\ :run) View Source
yggdrasil_pubsub_adapter(
  namespace :: atom(),
  type :: :run | :reload | :system | :config
) :: {:ok, term()} | {:error, term()}

Pub-sub adapter to use for channels. Default value is Phoenix.PubSub.PG2.

config :yggdrasil,
  pubsub_adapter: Phoenix.PubSub.PG2
Link to this function yggdrasil_pubsub_adapter!(namespace \\ nil) View Source
yggdrasil_pubsub_adapter!(namespace :: atom()) ::
  {:ok, term()} | {:error, term()}

Same as Elixir.Skogsra.yggdrasil_pubsub_adapter/1 but fails on error.

Link to this function yggdrasil_pubsub_name(namespace \\ nil, type \\ :run) View Source
yggdrasil_pubsub_name(
  namespace :: atom(),
  type :: :run | :reload | :system | :config
) :: {:ok, term()} | {:error, term()}

Pub-sub name. By default is Yggdrasil.PubSub.

config :yggdrasil,
  pubsub_name: Yggdrasil.PubSub
Link to this function yggdrasil_pubsub_name!(namespace \\ nil) View Source
yggdrasil_pubsub_name!(namespace :: atom()) :: {:ok, term()} | {:error, term()}

Same as Elixir.Skogsra.yggdrasil_pubsub_name/1 but fails on error.

Link to this function yggdrasil_pubsub_options(namespace \\ nil, type \\ :run) View Source
yggdrasil_pubsub_options(
  namespace :: atom(),
  type :: :run | :reload | :system | :config
) :: {:ok, term()} | {:error, term()}

Pub-sub options. By default are [pool_size: 1].

config :yggdrasil,
  pubsub_options: [pool_size: 1]
Link to this function yggdrasil_pubsub_options!(namespace \\ nil) View Source
yggdrasil_pubsub_options!(namespace :: atom()) ::
  {:ok, term()} | {:error, term()}

Same as Elixir.Skogsra.yggdrasil_pubsub_options/1 but fails on error.