Yggdrasil for RabbitMQ v5.0.2 Yggdrasil.RabbitMQ.Connection.Pool View Source

RabbitMQ connection pool.

Link to this section Summary

Types

Channel callback function.

Channel callback return.

Callback for running functions using RabbitMQ channels.

Functions

Returns a specification to start this module under a supervisor.

Starts a connection pool using an initial client. Optionally, it receives some Supervisor options.

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

Runs a channel callback in a client.

Link to this section Types

Link to this type

channel_callback()

View Source
channel_callback() :: (AMQP.Channel.t() -> channel_callback_return())

Channel callback function.

Link to this type

channel_callback_return()

View Source
channel_callback_return() :: {:ok, term()} | {:error, term()} | term()

Channel callback return.

Link to this type

rabbit_callback()

View Source
rabbit_callback() ::
  (Yggdrasil.Channel.t() -> :ok | {:ok, term()} | {:error, term()})

Callback for running functions using RabbitMQ channels.

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Starts a connection pool using an initial client. Optionally, it receives some Supervisor options.

Link to this function

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

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

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

Runs a channel callback in a client.