Method: AMQP::Channel#fanout

Defined in:

lib/amqp/channel.rb

#fanout(name = 'amq.fanout', opts = {}, &block) ⇒ Exchange

Defines, intializes and returns a fanout Exchange instance.

Learn more about fanout exchanges in Exchange class documentation.

Examples:

Using fanout exchange to deliver messages to multiple consumers

# open up a channel
# declare a fanout exchange
# declare 3 queues, binds them
# publish a message

Parameters:

• name (String) (defaults to: 'amq.fanout') —

  (amq.fanout) Exchange name.

• opts (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (opts):

• :passive (Boolean) — default: false —

  If set, the server will not create the exchange if it does not already exist. The client can use this to check whether an exchange exists without modifying the server state.

• :durable (Boolean) — default: false —

  If set when creating a new exchange, the exchange will be marked as durable. Durable exchanges and their bindings are recreated upon a server restart (information about them is persisted). Non-durable (transient) exchanges do not survive if/when a server restarts (information about them is stored exclusively in RAM).

• :auto_delete (Boolean) — default: false —

  If set, the exchange is deleted when all queues have finished using it. The server waits for a short period of time before determining the exchange is unused to give time to the client code to bind a queue to it.

• :internal (Boolean) — default: default false —

  If set, the exchange may not be used directly by publishers, but only when bound to other exchanges. Internal exchanges are used to construct wiring that is not visible to applications. This is a RabbitMQ-specific extension.

• :nowait (Boolean) — default: true —

  If set, the server will not respond to the method. The client should not wait for a reply method. If the server could not complete the method it will raise a channel or connection exception.

Returns:

• (Exchange)

See Also:

• Exchange
• Exchange#initialize
• #default_exchange
• AMQP 0.9.1 specification (Section 3.1.3.2)

# File 'lib/amqp/channel.rb', line 541

def fanout(name = 'amq.fanout', opts = {}, &block)
  if exchange = find_exchange(name)
    extended_opts = Exchange.add_default_options(:fanout, name, opts, block)

    validate_parameters_match!(exchange, extended_opts, :exchange)

    block.call(exchange) if block
    exchange
  else
    register_exchange(Exchange.new(self, :fanout, name, opts, &block))
  end
end