Yggdrasil for RabbitMQ v5.0.2 Yggdrasil.Settings.RabbitMQ View Source

This module defines the available settings for RabbitMQ in Yggdrasil.

Link to this section Summary

Functions

RabbitMQ heartbeat. Defaults to 10 seconds.

RabbitMQ heartbeat. Defaults to 10 seconds.

RabbitMQ hostname. Defaults to "localhost".

RabbitMQ hostname. Defaults to "localhost".

RabbitMQ max retries for the backoff algorithm. Defaults to 3.

RabbitMQ max retries for the backoff algorithm. Defaults to 3.

RabbitMQ password. Defaults to "guest".

RabbitMQ password. Defaults to "guest".

RabbitMQ port. Defaults to 5672.

RabbitMQ port. Defaults to 5672.

RabbitMQ amount of publisher connections.

RabbitMQ amount of publisher connections.

Puts the value to Yggdrasil.Settings.RabbitMQ.heartbeat/0. Optionally, receives the namespace.

Puts the value to Yggdrasil.Settings.RabbitMQ.hostname/0. Optionally, receives the namespace.

Puts the value to Yggdrasil.Settings.RabbitMQ.max_retries/0. Optionally, receives the namespace.

Puts the value to Yggdrasil.Settings.RabbitMQ.password/0. Optionally, receives the namespace.

Puts the value to Yggdrasil.Settings.RabbitMQ.port/0. Optionally, receives the namespace.

Puts the value to Yggdrasil.Settings.RabbitMQ.slot_size/0. Optionally, receives the namespace.

Puts the value to Yggdrasil.Settings.RabbitMQ.username/0. Optionally, receives the namespace.

Puts the value to Yggdrasil.Settings.RabbitMQ.virtual_host/0. Optionally, receives the namespace.

Reloads the value for Yggdrasil.Settings.RabbitMQ.heartbeat/0. Optionally, receives the namespace for the variable.

Reloads the value for Yggdrasil.Settings.RabbitMQ.hostname/0. Optionally, receives the namespace for the variable.

Reloads the value for Yggdrasil.Settings.RabbitMQ.max_retries/0. Optionally, receives the namespace for the variable.

Reloads the value for Yggdrasil.Settings.RabbitMQ.password/0. Optionally, receives the namespace for the variable.

Reloads the value for Yggdrasil.Settings.RabbitMQ.port/0. Optionally, receives the namespace for the variable.

Reloads the value for Yggdrasil.Settings.RabbitMQ.publisher_connections/0. Optionally, receives the namespace for the variable.

Reloads the value for Yggdrasil.Settings.RabbitMQ.slot_size/0. Optionally, receives the namespace for the variable.

Reloads the value for Yggdrasil.Settings.RabbitMQ.subscriber_connections/0. Optionally, receives the namespace for the variable.

Reloads the value for Yggdrasil.Settings.RabbitMQ.username/0. Optionally, receives the namespace for the variable.

Reloads the value for Yggdrasil.Settings.RabbitMQ.virtual_host/0. Optionally, receives the namespace for the variable.

RabbitMQ slot size for the backoff algorithm. Defaults to 10.

RabbitMQ slot size for the backoff algorithm. Defaults to 10.

RabbitMQ amount of subscriber connections.

RabbitMQ amount of subscriber connections.

Creates a template for OS environment variables given a filename. Additionally, it can receive a list of options

RabbitMQ username. Defaults to "guest".

RabbitMQ username. Defaults to "guest".

RabbitMQ virtual host. Defaults to "/".

RabbitMQ virtual host. Defaults to "/".

Link to this section Functions

Link to this function

heartbeat(namespace \\ nil)

View Source
heartbeat(Skogsra.Env.namespace()) :: {:ok, integer()} | {:error, binary()}

RabbitMQ heartbeat. Defaults to 10 seconds.

iex> Yggdrasil.Settings.RabbitMQ.heartbeat()
{:ok, 10}

Calling Yggdrasil.Settings.RabbitMQ.heartbeat() will ensure the following:

  • Binding order: [:system, :config]
  • OS environment variable: "YGGDRASIL_RABBITMQ_HEARTBEAT"
  • Type: :integer
  • Default: 10
  • Required: false
  • Cached: true
Link to this function

heartbeat!(namespace \\ nil)

View Source
heartbeat!(Skogsra.Env.namespace()) :: integer() | no_return()

RabbitMQ heartbeat. Defaults to 10 seconds.

iex> Yggdrasil.Settings.RabbitMQ.heartbeat()
{:ok, 10}

Bang version of Yggdrasil.Settings.RabbitMQ.heartbeat/0 (fails on error). Optionally, receives the namespace for the variable.

Link to this function

hostname(namespace \\ nil)

View Source
hostname(Skogsra.Env.namespace()) :: {:ok, binary()} | {:error, binary()}

RabbitMQ hostname. Defaults to "localhost".

Calling Yggdrasil.Settings.RabbitMQ.hostname() will ensure the following:

  • Binding order: [:system, :config]
  • OS environment variable: "YGGDRASIL_RABBITMQ_HOSTNAME"
  • Type: :binary
  • Default: "localhost"
  • Required: false
  • Cached: true
Link to this function

hostname!(namespace \\ nil)

View Source
hostname!(Skogsra.Env.namespace()) :: binary() | no_return()

RabbitMQ hostname. Defaults to "localhost".

Bang version of Yggdrasil.Settings.RabbitMQ.hostname/0 (fails on error). Optionally, receives the namespace for the variable.

Link to this function

max_retries(namespace \\ nil)

View Source
max_retries(Skogsra.Env.namespace()) :: {:ok, integer()} | {:error, binary()}

RabbitMQ max retries for the backoff algorithm. Defaults to 3.

The backoff algorithm is exponential:

backoff_time = pow(2, retries) * random(1, slot) * 1_000 ms

when retries <= MAX_RETRIES and slot is given by the configuration variable Elixir.Yggdrasil.Settings.RabbitMQ.slot_size/0 (defaults to 10 secs).

iex> Yggdrasil.Settings.RabbitMQ.max_retries()
{:ok, 3}

Calling Yggdrasil.Settings.RabbitMQ.max_retries() will ensure the following:

  • Binding order: [:system, :config]
  • OS environment variable: "YGGDRASIL_RABBITMQ_MAX_RETRIES"
  • Type: :integer
  • Default: 3
  • Required: false
  • Cached: true
Link to this function

max_retries!(namespace \\ nil)

View Source
max_retries!(Skogsra.Env.namespace()) :: integer() | no_return()

RabbitMQ max retries for the backoff algorithm. Defaults to 3.

The backoff algorithm is exponential:

backoff_time = pow(2, retries) * random(1, slot) * 1_000 ms

when retries <= MAX_RETRIES and slot is given by the configuration variable Elixir.Yggdrasil.Settings.RabbitMQ.slot_size/0 (defaults to 10 secs).

iex> Yggdrasil.Settings.RabbitMQ.max_retries()
{:ok, 3}

Bang version of Yggdrasil.Settings.RabbitMQ.max_retries/0 (fails on error). Optionally, receives the namespace for the variable.

Link to this function

password(namespace \\ nil)

View Source
password(Skogsra.Env.namespace()) :: {:ok, binary()} | {:error, binary()}

RabbitMQ password. Defaults to "guest".

iex> Yggdrasil.Settings.RabbitMQ.password()
{:ok, "guest"}

Calling Yggdrasil.Settings.RabbitMQ.password() will ensure the following:

  • Binding order: [:system, :config]
  • OS environment variable: "YGGDRASIL_RABBITMQ_PASSWORD"
  • Type: :binary
  • Default: "guest"
  • Required: false
  • Cached: true
Link to this function

password!(namespace \\ nil)

View Source
password!(Skogsra.Env.namespace()) :: binary() | no_return()

RabbitMQ password. Defaults to "guest".

iex> Yggdrasil.Settings.RabbitMQ.password()
{:ok, "guest"}

Bang version of Yggdrasil.Settings.RabbitMQ.password/0 (fails on error). Optionally, receives the namespace for the variable.

Link to this function

port(namespace \\ nil)

View Source
port(Skogsra.Env.namespace()) :: {:ok, integer()} | {:error, binary()}

RabbitMQ port. Defaults to 5672.

iex> Yggdrasil.Settings.RabbitMQ.port()
{:ok, 5672}

Calling Yggdrasil.Settings.RabbitMQ.port() will ensure the following:

  • Binding order: [:system, :config]
  • OS environment variable: "YGGDRASIL_RABBITMQ_PORT"
  • Type: :integer
  • Default: 5672
  • Required: false
  • Cached: true

RabbitMQ port. Defaults to 5672.

iex> Yggdrasil.Settings.RabbitMQ.port()
{:ok, 5672}

Bang version of Yggdrasil.Settings.RabbitMQ.port/0 (fails on error). Optionally, receives the namespace for the variable.

Link to this function

publisher_connections(namespace \\ nil)

View Source
publisher_connections(Skogsra.Env.namespace()) ::
  {:ok, integer()} | {:error, binary()}

RabbitMQ amount of publisher connections.

iex> Yggdrasil.Settings.RabbitMQ.publisher_connections()
{:ok, 1}

Calling Yggdrasil.Settings.RabbitMQ.publisher_connections() will ensure the following:

  • Binding order: [:system, :config]
  • OS environment variable: "YGGDRASIL_RABBITMQ_PUBLISHER_CONNECTIONS"
  • Type: :integer
  • Default: 1
  • Required: false
  • Cached: true
Link to this function

publisher_connections!(namespace \\ nil)

View Source
publisher_connections!(Skogsra.Env.namespace()) :: integer() | no_return()

RabbitMQ amount of publisher connections.

iex> Yggdrasil.Settings.RabbitMQ.publisher_connections()
{:ok, 1}

Bang version of Yggdrasil.Settings.RabbitMQ.publisher_connections/0 (fails on error). Optionally, receives the namespace for the variable.

Link to this function

put_heartbeat(value, namespace \\ nil)

View Source
put_heartbeat(integer(), Skogsra.Env.namespace()) :: :ok | {:error, binary()}

Puts the value to Yggdrasil.Settings.RabbitMQ.heartbeat/0. Optionally, receives the namespace.

Link to this function

put_hostname(value, namespace \\ nil)

View Source
put_hostname(binary(), Skogsra.Env.namespace()) :: :ok | {:error, binary()}

Puts the value to Yggdrasil.Settings.RabbitMQ.hostname/0. Optionally, receives the namespace.

Link to this function

put_max_retries(value, namespace \\ nil)

View Source
put_max_retries(integer(), Skogsra.Env.namespace()) :: :ok | {:error, binary()}

Puts the value to Yggdrasil.Settings.RabbitMQ.max_retries/0. Optionally, receives the namespace.

Link to this function

put_password(value, namespace \\ nil)

View Source
put_password(binary(), Skogsra.Env.namespace()) :: :ok | {:error, binary()}

Puts the value to Yggdrasil.Settings.RabbitMQ.password/0. Optionally, receives the namespace.

Link to this function

put_port(value, namespace \\ nil)

View Source
put_port(integer(), Skogsra.Env.namespace()) :: :ok | {:error, binary()}

Puts the value to Yggdrasil.Settings.RabbitMQ.port/0. Optionally, receives the namespace.

Link to this function

put_publisher_connections(value, namespace \\ nil)

View Source
put_publisher_connections(integer(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Yggdrasil.Settings.RabbitMQ.publisher_connections/0. Optionally, receives the namespace.

Link to this function

put_slot_size(value, namespace \\ nil)

View Source
put_slot_size(integer(), Skogsra.Env.namespace()) :: :ok | {:error, binary()}

Puts the value to Yggdrasil.Settings.RabbitMQ.slot_size/0. Optionally, receives the namespace.

Link to this function

put_subscriber_connections(value, namespace \\ nil)

View Source
put_subscriber_connections(integer(), Skogsra.Env.namespace()) ::
  :ok | {:error, binary()}

Puts the value to Yggdrasil.Settings.RabbitMQ.subscriber_connections/0. Optionally, receives the namespace.

Link to this function

put_username(value, namespace \\ nil)

View Source
put_username(binary(), Skogsra.Env.namespace()) :: :ok | {:error, binary()}

Puts the value to Yggdrasil.Settings.RabbitMQ.username/0. Optionally, receives the namespace.

Link to this function

put_virtual_host(value, namespace \\ nil)

View Source
put_virtual_host(binary(), Skogsra.Env.namespace()) :: :ok | {:error, binary()}

Puts the value to Yggdrasil.Settings.RabbitMQ.virtual_host/0. Optionally, receives the namespace.

Link to this function

reload_heartbeat(namespace \\ nil)

View Source
reload_heartbeat(Skogsra.Env.namespace()) ::
  {:ok, integer()} | {:error, binary()}

Reloads the value for Yggdrasil.Settings.RabbitMQ.heartbeat/0. Optionally, receives the namespace for the variable.

Link to this function

reload_hostname(namespace \\ nil)

View Source
reload_hostname(Skogsra.Env.namespace()) :: {:ok, binary()} | {:error, binary()}

Reloads the value for Yggdrasil.Settings.RabbitMQ.hostname/0. Optionally, receives the namespace for the variable.

Link to this function

reload_max_retries(namespace \\ nil)

View Source
reload_max_retries(Skogsra.Env.namespace()) ::
  {:ok, integer()} | {:error, binary()}

Reloads the value for Yggdrasil.Settings.RabbitMQ.max_retries/0. Optionally, receives the namespace for the variable.

Link to this function

reload_password(namespace \\ nil)

View Source
reload_password(Skogsra.Env.namespace()) :: {:ok, binary()} | {:error, binary()}

Reloads the value for Yggdrasil.Settings.RabbitMQ.password/0. Optionally, receives the namespace for the variable.

Link to this function

reload_port(namespace \\ nil)

View Source
reload_port(Skogsra.Env.namespace()) :: {:ok, integer()} | {:error, binary()}

Reloads the value for Yggdrasil.Settings.RabbitMQ.port/0. Optionally, receives the namespace for the variable.

Link to this function

reload_publisher_connections(namespace \\ nil)

View Source
reload_publisher_connections(Skogsra.Env.namespace()) ::
  {:ok, integer()} | {:error, binary()}

Reloads the value for Yggdrasil.Settings.RabbitMQ.publisher_connections/0. Optionally, receives the namespace for the variable.

Link to this function

reload_slot_size(namespace \\ nil)

View Source
reload_slot_size(Skogsra.Env.namespace()) ::
  {:ok, integer()} | {:error, binary()}

Reloads the value for Yggdrasil.Settings.RabbitMQ.slot_size/0. Optionally, receives the namespace for the variable.

Link to this function

reload_subscriber_connections(namespace \\ nil)

View Source
reload_subscriber_connections(Skogsra.Env.namespace()) ::
  {:ok, integer()} | {:error, binary()}

Reloads the value for Yggdrasil.Settings.RabbitMQ.subscriber_connections/0. Optionally, receives the namespace for the variable.

Link to this function

reload_username(namespace \\ nil)

View Source
reload_username(Skogsra.Env.namespace()) :: {:ok, binary()} | {:error, binary()}

Reloads the value for Yggdrasil.Settings.RabbitMQ.username/0. Optionally, receives the namespace for the variable.

Link to this function

reload_virtual_host(namespace \\ nil)

View Source
reload_virtual_host(Skogsra.Env.namespace()) ::
  {:ok, binary()} | {:error, binary()}

Reloads the value for Yggdrasil.Settings.RabbitMQ.virtual_host/0. Optionally, receives the namespace for the variable.

Link to this function

slot_size(namespace \\ nil)

View Source
slot_size(Skogsra.Env.namespace()) :: {:ok, integer()} | {:error, binary()}

RabbitMQ slot size for the backoff algorithm. Defaults to 10.

iex> Yggdrasil.Settings.RabbitMQ.slot_size()
{:ok, 10}

Calling Yggdrasil.Settings.RabbitMQ.slot_size() will ensure the following:

  • Binding order: [:system, :config]
  • OS environment variable: "YGGDRASIL_RABBITMQ_SLOT_SIZE"
  • Type: :integer
  • Default: 10
  • Required: false
  • Cached: true
Link to this function

slot_size!(namespace \\ nil)

View Source
slot_size!(Skogsra.Env.namespace()) :: integer() | no_return()

RabbitMQ slot size for the backoff algorithm. Defaults to 10.

iex> Yggdrasil.Settings.RabbitMQ.slot_size()
{:ok, 10}

Bang version of Yggdrasil.Settings.RabbitMQ.slot_size/0 (fails on error). Optionally, receives the namespace for the variable.

Link to this function

subscriber_connections(namespace \\ nil)

View Source
subscriber_connections(Skogsra.Env.namespace()) ::
  {:ok, integer()} | {:error, binary()}

RabbitMQ amount of subscriber connections.

iex> Yggdrasil.Settings.RabbitMQ.subscriber_connections()
{:ok, 1}

Calling Yggdrasil.Settings.RabbitMQ.subscriber_connections() will ensure the following:

  • Binding order: [:system, :config]
  • OS environment variable: "YGGDRASIL_RABBITMQ_SUBSCRIBER_CONNECTIONS"
  • Type: :integer
  • Default: 1
  • Required: false
  • Cached: true
Link to this function

subscriber_connections!(namespace \\ nil)

View Source
subscriber_connections!(Skogsra.Env.namespace()) :: integer() | no_return()

RabbitMQ amount of subscriber connections.

iex> Yggdrasil.Settings.RabbitMQ.subscriber_connections()
{:ok, 1}

Bang version of Yggdrasil.Settings.RabbitMQ.subscriber_connections/0 (fails on error). Optionally, receives the namespace for the variable.

Link to this function

template(filename, options \\ [])

View Source
template(Path.t(), keyword()) :: :ok | {:error, File.posix()}

Creates a template for OS environment variables given a filename. Additionally, it can receive a list of options:

  • type: What kind of file it will generate (:elixir, :unix, :windows).
  • namespace: Namespace for the variables.
Link to this function

username(namespace \\ nil)

View Source
username(Skogsra.Env.namespace()) :: {:ok, binary()} | {:error, binary()}

RabbitMQ username. Defaults to "guest".

iex> Yggdrasil.Settings.RabbitMQ.username()
{:ok, "guest"}

Calling Yggdrasil.Settings.RabbitMQ.username() will ensure the following:

  • Binding order: [:system, :config]
  • OS environment variable: "YGGDRASIL_RABBITMQ_USERNAME"
  • Type: :binary
  • Default: "guest"
  • Required: false
  • Cached: true
Link to this function

username!(namespace \\ nil)

View Source
username!(Skogsra.Env.namespace()) :: binary() | no_return()

RabbitMQ username. Defaults to "guest".

iex> Yggdrasil.Settings.RabbitMQ.username()
{:ok, "guest"}

Bang version of Yggdrasil.Settings.RabbitMQ.username/0 (fails on error). Optionally, receives the namespace for the variable.

Link to this function

virtual_host(namespace \\ nil)

View Source
virtual_host(Skogsra.Env.namespace()) :: {:ok, binary()} | {:error, binary()}

RabbitMQ virtual host. Defaults to "/".

iex> Yggdrasil.Settings.RabbitMQ.virtual_host()
{:ok, "/"}

Calling Yggdrasil.Settings.RabbitMQ.virtual_host() will ensure the following:

  • Binding order: [:system, :config]
  • OS environment variable: "YGGDRASIL_RABBITMQ_VIRTUAL_HOST"
  • Type: :binary
  • Default: "/"
  • Required: false
  • Cached: true
Link to this function

virtual_host!(namespace \\ nil)

View Source
virtual_host!(Skogsra.Env.namespace()) :: binary() | no_return()

RabbitMQ virtual host. Defaults to "/".

iex> Yggdrasil.Settings.RabbitMQ.virtual_host()
{:ok, "/"}

Bang version of Yggdrasil.Settings.RabbitMQ.virtual_host/0 (fails on error). Optionally, receives the namespace for the variable.