View Source Lapin.Producer behaviour (lapin v2.0.0)

Extensible behaviour to define producer configuration.

Lapin provides a number of submodules which implement the patterns found in the RabbitMQ Tutorials.

defmodule ExampleApp.SomePatter do
  use Lapin.Producer

  [... callbacks implementation ...]
end

Summary

Types

config()

Producer configuration

t()

Lapin Producer

Callbacks

confirm(producer)

Request publisher confirms (RabbitMQ only)

exchange(producer)

Declare exchange

mandatory(producer)

Request message mandatory routing when publishing

persistent(producer)

Request message persistence when publishing

Functions

confirm(map)

Wait for publish confirmation

create(connection, config)

Creates a producer from configuration

get(producers, exchange)

Find consumer by consumer_tag

publish(map, exchange, routing_key, payload, options)

Publish message

Types

config()

@type config() :: Keyword.t()

Producer configuration

The following keys are supported:

pattern: producer pattern (module using the Lapin.Producer behaviour)

If using the Lapin.Producer.Config default implementation, the following keys are also supported:

exchange: exchange used for publish (String.t, required)
confirm: expect RabbitMQ publish confirms (boolean(), default: false)
mandatory: messages published as mandatory by default (boolean(), default: false)
persistent: messages published as persistent by default (boolean(), default: false)

t()

@type t() :: %Lapin.Producer{
  channel: AMQP.Channel.t(),
  config: config(),
  exchange: String.t(),
  pattern: atom()
}

Lapin Producer

Callbacks

confirm(producer)

@callback confirm(producer :: t()) :: boolean()

Request publisher confirms (RabbitMQ only)

exchange(producer)

@callback exchange(producer :: t()) :: Lapin.Exchange.t()

Declare exchange

mandatory(producer)

@callback mandatory(producer :: t()) :: boolean()

Request message mandatory routing when publishing

persistent(producer)

@callback persistent(producer :: t()) :: boolean()

Request message persistence when publishing

Functions

confirm(map)

@spec confirm(t()) :: boolean()

Wait for publish confirmation

create(connection, config)

@spec create(AMQP.Connection.t(), config()) :: t()

Creates a producer from configuration

get(producers, exchange)

@spec get([t()], String.t()) :: {:ok, t()} | {:error, :not_found}

Find consumer by consumer_tag

publish(map, exchange, routing_key, payload, options)

@spec publish(
  t(),
  Lapin.Exchange.name(),
  Lapin.Exchange.routing_key(),
  Lapin.Message.payload(),
  Keyword.t()
) :: :ok | {:error, term()}

Publish message