lapin v1.0.5

View Source Lapin.Producer behaviour (lapin v1.0.5)

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

Link to this section 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

Link to this section Types

Link to this type

config()

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

Producer configuration

The following keys are supported:

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)
Link to this type

t()

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

Lapin Producer

Link to this section Callbacks

Link to this callback

confirm(producer)

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

Request publisher confirms (RabbitMQ only)

Link to this callback

exchange(producer)

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

Declare exchange

Link to this callback

mandatory(producer)

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

Request message mandatory routing when publishing

Link to this callback

persistent(producer)

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

Request message persistence when publishing

Link to this section Functions

Link to this function

confirm(map)

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

Wait for publish confirmation

Link to this function

create(connection, config)

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

Creates a producer from configuration

Link to this function

get(producers, exchange)

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

Find consumer by consumer_tag

Link to this function

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

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

Publish message