Module: AMQP

Defined in:
lib/amqp.rb,
lib/amqp/queue.rb,
lib/amqp/header.rb,
lib/amqp/broker.rb,
lib/amqp/entity.rb,
lib/amqp/version.rb,
lib/amqp/session.rb,
lib/amqp/bit_set.rb,
lib/amqp/channel.rb,
lib/amqp/openable.rb,
lib/amqp/settings.rb,
lib/amqp/consumer.rb,
lib/amqp/exchange.rb,
lib/amqp/callbacks.rb,
lib/amqp/deferrable.rb,
lib/amqp/exceptions.rb,
lib/amqp/int_allocator.rb,
lib/amqp/handlers_registry.rb,
lib/amqp/integration/rails.rb,
lib/amqp/channel_id_allocator.rb,
lib/amqp/framing/string/frame.rb,
lib/amqp/utilities/server_type.rb,
lib/amqp/consumer_tag_generator.rb,
lib/amqp/auth_mechanism_adapter.rb,
lib/amqp/utilities/event_loop_helper.rb,
lib/amqp/auth_mechanism_adapter/plain.rb,
lib/amqp/auth_mechanism_adapter/external.rb

Overview

Original version is from Qusion project by Daniel DeLeo.

Copyright © 2009 Daniel DeLeo Copyright © 2011 Michael Klishin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Defined Under Namespace

Modules: Callbacks, ChannelIdAllocator, Entity, Framing, Integration, Openable, ProtocolMethodHandlers, RegisterEntityMixin, ServerNamedEntity, Settings, Utilities Classes: AuthMechanismAdapter, Broker, Channel, ChannelClosedError, ConnectionClosedError, Consumer, ConsumerTagGenerator, Error, Exchange, HandlersRegistry, Header, IncompatibleOptionsError, PossibleAuthenticationFailureError, Queue, Session, TCPConnectionFailed

Constant Summary

VERSION =

amqp gem version. Not to be confused with the AMQP protocol version it implements. For that, see AMQ::Protocol::VERSION

Returns:

  • (String)

    AMQP gem version

See Also:

  • AMQ::Protocol::VERSION
'1.5.0.pre'
BitSet =

A forward reference for AMQP::BitSet that was extracted to amq-protocol to make it possible to reuse it in Bunny.

AMQ::BitSet
Deferrable =
EventMachine::DefaultDeferrable
IntAllocator =

A forward reference for AMQP::IntAllocator that was extracted to amq-protocol to make it possible to reuse it in Bunny.

AMQ::IntAllocator

Class Method Summary (collapse)

Class Method Details

+ (Object) channel

“Default channel”. A placeholder for apps that only want to use one channel. This channel is not global, not used under the hood by methods like AMQP::Exchange#initialize and only shared by exchanges/queues you decide on. To reiterate: this is only a conventience accessor, since many apps (especially Web apps) can get by with just one connection and one channel.



131
132
133
# File 'lib/amqp.rb', line 131

def self.channel
  @channel
end

+ (Object) channel=(value)

A placeholder for applications that only need one channel. If you use start to set up default connection, channel is open on that connection, but can be replaced by your application.

See Also:



141
142
143
# File 'lib/amqp.rb', line 141

def self.channel=(value)
  @channel = value
end

+ (Boolean) closing?

Indicates that default connection is closing.

Returns:

  • (Boolean)


101
102
103
# File 'lib/amqp.rb', line 101

def self.closing?
  @connection.closing?
end

+ (Object) conn

Deprecated.

Alias for connection



154
155
156
157
# File 'lib/amqp.rb', line 154

def self.conn
  warn "AMQP.conn will be removed in 1.0. Please use AMQP.connection."
  @connection
end

+ (Object) conn=(value)

Deprecated.

Alias for connection=



162
163
164
165
# File 'lib/amqp.rb', line 162

def self.conn=(value)
  warn "AMQP.conn= will be removed in 1.0. Please use AMQP.connection=(connection)."
  self.connection = value
end

+ (AMQP::Session) connect(connection_string, options = {}) + (AMQP::Session) connect(connection_options)

Note:

This method assumes that EventMachine even loop is already running. If it is not the case or you are not sure, we recommend you use start instead. It takes exactly the same parameters.

Connects to AMQP broker and yields connection object to the block as soon as connection is considered open.

Handling authentication failures

AMQP 0.9.1 specification dictates that broker closes TCP connection when it detects that authentication has failed. However, broker does exactly the same thing when other connection-level exception occurs so there is no way to guarantee that connection was closed because of authentication failure.

Because of that, AMQP gem follows Java client example and hints at possibility of authentication failure. To handle it, pass a callable object (a proc, a lambda, an instance of a class that responds to #call) with :on_possible_authentication_failure option.

Examples:

Using AMQP.connect with default connection settings


AMQP.connect do |connection|
  AMQP::Channel.new(connection) do |channel|
    # channel is ready: set up your messaging flow by creating exchanges,
    # queues, binding them together and so on.
  end
end

Using AMQP.connect to connect to a public RabbitMQ instance with connection settings given as a hash


AMQP.connect(:host => "dev.rabbitmq.com", :username => "guest", :password => "guest") do |connection|
  AMQP::Channel.new(connection) do |channel|
    # ...
  end
end

Using AMQP.connect to connect to a public RabbitMQ instance with connection settings given as a URI


AMQP.connect "amqp://guest:guest@dev.rabbitmq.com:5672", :on_possible_authentication_failure => Proc.new { puts("Looks like authentication has failed") } do |connection|
  AMQP::Channel.new(connection) do |channel|
    # ...
  end
end

Overloads:

  • + (AMQP::Session) connect(connection_string, options = {})

    Used to pass connection parameters as a connection string

    Parameters:

    • :connection_string (String)

      AMQP connection URI, à la JDBC connection string. For example: amqp://bus.megacorp.internal:5877/qa

  • + (AMQP::Session) connect(connection_options)

    Used to pass connection options as a Hash.

    Parameters:

    • :connection_options (Hash)

      AMQP connection options (:host, :port, :username, :vhost, :password)

Parameters:

  • connection_options_or_string (Hash) (defaults to: {})

    a customizable set of options

Options Hash (connection_options_or_string):

  • :host (String) — default: "localhost"

    Host to connect to.

  • :port (Integer) — default: 5672

    Port to connect to.

  • :vhost (String) — default: "/"

    Virtual host to connect to.

  • :username (String) — default: "guest"

    Username to use. Also can be specified as :user.

  • :password (String) — default: "guest"

    Password to use. Also can be specified as :pass.

  • :ssl (Hash)

    TLS (SSL) parameters to use.

  • :heartbeat (Fixnum) — default: 0

    Connection heartbeat, in seconds. 0 means no heartbeat. Can also be configured server-side starting with RabbitMQ 3.0.

  • :on_tcp_connection_failure (#call)

    A callable object that will be run if connection to server fails

  • :on_possible_authentication_failure (#call)

    A callable object that will be run if authentication fails (see Authentication failure section)

Returns:



232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/amqp.rb', line 232

def self.connect(connection_options_or_string = {}, other_options = {}, &block)
  opts = case connection_options_or_string
         when String then
           AMQP::Settings.parse_connection_uri(connection_options_or_string)
         when Hash then
           connection_options_or_string
         else
           Hash.new
         end

  AMQP::Session.connect(opts.merge(other_options), &block)
end

+ (Object) connection

Default connection. When you do not pass connection instance to methods like AMQP::Channel#initialize, AMQP gem will use this default connection.



121
122
123
# File 'lib/amqp.rb', line 121

def self.connection
  @connection
end

+ (Object) connection=(value)

Sets global connection object.



147
148
149
# File 'lib/amqp.rb', line 147

def self.connection=(value)
  @connection = value
end

+ (Boolean) logging

Returns Current global logging value

Returns:

  • (Boolean)

    Current global logging value



107
108
109
# File 'lib/amqp.rb', line 107

def self.logging
  self.settings[:logging]
end

+ (Boolean) logging=(value)

Returns Sets current global logging value

Returns:

  • (Boolean)

    Sets current global logging value



113
114
115
# File 'lib/amqp.rb', line 113

def self.logging=(value)
  self.settings[:logging] = !!value
end

+ (Object) run(*args, &block)

Alias for start



67
68
69
# File 'lib/amqp.rb', line 67

def self.run(*args, &block)
  self.start(*args, &block)
end

+ (Hash) settings

Returns Default AMQP connection settings. This hash may be modified.

Returns:

  • (Hash)

    Default AMQP connection settings. This hash may be modified.



247
248
249
# File 'lib/amqp.rb', line 247

def self.settings
  @settings ||= AMQP::Settings.default
end

+ (Object) start(connection_options_or_string = {}, other_options = {}, &block)

Starts EventMachine event loop unless it is already running and connects to AMQP broker using connect. It is generally a good idea to start EventMachine event loop in a separate thread and use connect (for Web applications that do not use Thin or Goliath, it is the only option).

See connect for information about arguments this method takes and information about relevant topics such as authentication failure handling.

Examples:

Using AMQP.start to connect to AMQP broker, EventMachine loop isn’t yet running

AMQP.start do |connection|
  # default is to connect to localhost:5672, to root ("/") vhost as guest/guest

  # this block never exits unless either AMQP.stop or EM.stop
  # is called.

  AMQP::Channel(connection) do |channel|
    channel.queue("", :auto_delete => true).bind(channel.fanout("amq.fanout")).subscribe do |headers, payload|
      # handle deliveries here
    end
  end
end


55
56
57
58
59
60
61
62
63
# File 'lib/amqp.rb', line 55

def self.start(connection_options_or_string = {}, other_options = {}, &block)
  EM.run do
    if !@connection || @connection.closed? || @connection.closing?
      @connection   = connect(connection_options_or_string, other_options, &block)
    end
    @channel      = Channel.new(@connection)
    @connection
  end
end

+ (Object) stop(reply_code = 200, reply_text = "Goodbye", &block)

Note:

If default connection was never established or is in the closing state already, this method has no effect.

Properly closes default AMQP connection and then underlying TCP connection. Pass it a block if you want a piece of code to be run once default connection is successfully closed.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/amqp.rb', line 78

def self.stop(reply_code = 200, reply_text = "Goodbye", &block)
  return if @connection.nil? || self.closing?

  EM.next_tick do
    if AMQP.channel and AMQP.channel.open? and AMQP.channel.connection.open?
      AMQP.channel.close
    end
    AMQP.channel = nil


    shim = Proc.new {
      block.call

      AMQP.connection = nil
    }
    @connection.disconnect(reply_code, reply_text, &shim)
  end
end