Yggdrasil.RabbitMQ.Connection.Generator (Yggdrasil for RabbitMQ v6.0.0) View Source

This module defines a supervisor for creating connection pools on demand.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Starts a connection pool generator.

stop(generator, reason \\ :normal, timeout \\ :infinity)

Stops a connection pool generator. Optionally, it receives a reason (defaults to :normal) and a timeout (default to :infinity).

with_channel(client, callback \\ &({:ok, &1}))

Runs a channel callback in a client.

Link to this section Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

start_link(options \\ [])

Specs

start_link([DynamicSupervisor.option() | DynamicSupervisor.init_option()]) ::
  Supervisor.on_start()

Starts a connection pool generator.

stop(generator, reason \\ :normal, timeout \\ :infinity)

Specs

stop(Supervisor.supervisor(), term(), :infinity | non_neg_integer()) :: :ok

Stops a connection pool generator. Optionally, it receives a reason (defaults to :normal) and a timeout (default to :infinity).

with_channel(client, callback \\ &({:ok, &1}))

Specs

with_channel(
  Yggdrasil.RabbitMQ.Client.t(),
  Yggdrasil.RabbitMQ.Connection.Pool.channel_callback()
) :: Yggdrasil.RabbitMQ.Connection.Pool.channel_callback_return()

Runs a channel callback in a client.