### Home Classes Methods

### In Files

- lib/amqp/channel.rb
- lib/amqp/exchange.rb
- lib/amqp/utilities/server_type.rb
- lib/amqp/utilities/event_loop_helper.rb
- lib/amqp/version.rb
- lib/amqp/header.rb
- lib/amqp/broker.rb
- lib/amqp/session.rb
- lib/amqp/connection.rb
- lib/amqp/queue.rb
- lib/amqp/client.rb
- lib/amqp/integration/rails.rb
- lib/amqp/bit_set.rb
- lib/amqp/exceptions.rb
- lib/amqp/int_allocator.rb
- lib/amqp/consumer.rb

### Namespace

- MODULE AMQP::Client
- MODULE AMQP::Integration
- MODULE AMQP::Utilities
- CLASS AMQP::Broker
- CLASS AMQP::Channel
- CLASS AMQP::ChannelClosedError
- CLASS AMQP::Consumer
- CLASS AMQP::Error
- CLASS AMQP::Exchange
- CLASS AMQP::Header
- CLASS AMQP::IncompatibleOptionsError
- CLASS AMQP::PossibleAuthenticationFailureError
- CLASS AMQP::Queue
- CLASS AMQP::Session
- CLASS AMQP::TCPConnectionFailed

### Methods

- ::channel
- ::channel=
- ::client
- ::client=
- ::closing?
- ::conn
- ::conn=
- ::connect
- ::connection
- ::connection=
- ::logging
- ::logging=
- ::run
- ::settings
- ::start
- ::stop

### Class/Module Index

Quicksearch

- AMQP
- AMQP::Broker
- AMQP::Channel
- AMQP::ChannelClosedError
- AMQP::Client
- AMQP::Consumer
- AMQP::Error
- AMQP::Exchange
- AMQP::Header
- AMQP::IncompatibleOptionsError
- AMQP::Integration
- AMQP::Integration::Rails
- AMQP::PossibleAuthenticationFailureError
- AMQP::Queue
- AMQP::Session
- AMQP::TCPConnectionFailed
- AMQP::Utilities
- AMQP::Utilities::EventLoopHelper
- AMQP::Utilities::ServerType

No matching classes.

# AMQP

Original version is from Qusion project by Daniel DeLeo.

Copyright (c) 2009 Daniel DeLeo Copyright (c) 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.

Top-level namespace of amqp gem. Please refer to "See also" section below.

@see AMQP.connect @see AMQP.start @see AMQP::Channel @see AMQP::Exchange @see AMQP::Queue

### Constants

BitSet

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

IntAllocator

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

VERSION

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

  @see AMQ::Protocol::VERSION @return [String] AMQP gem version

### Public Class Methods

channel() click to toggle source

"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.

@api public

    # File lib/amqp/connection.rb, line 112
    def self.channel
      @channel
    end

channel=(value) click to toggle source

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

@see AMQP.channel @api public

    # File lib/amqp/connection.rb, line 122
    def self.channel=(value)
      @channel = value
    end

client() click to toggle source

@private

    # File lib/amqp/client.rb, line 94
    def self.client
      @client_implementation ||= AMQP::Session
    end

client=(value) click to toggle source

@private

    # File lib/amqp/client.rb, line 99
    def self.client=(value)
      @client_implementation = value
    end

closing?() click to toggle source

Indicates that default connection is closing.

@return [Boolean] @api public

    # File lib/amqp/connection.rb, line 82
    def self.closing?
      @connection.closing?
    end

conn() click to toggle source

Alias for {AMQP.connection} @deprecated @api public

    # File lib/amqp/connection.rb, line 135
    def self.conn
      warn "AMQP.conn will be removed in 1.0. Please use AMQP.connection."
      @connection
    end

conn=(value) click to toggle source

Alias for {AMQP.connection=} @deprecated @api public

    # File lib/amqp/connection.rb, line 143
    def self.conn=(value)
      warn "AMQP.conn= will be removed in 1.0. Please use AMQP.connection=(connection)."
      self.connection = value
    end

connect(connection_options_or_string = {}, other_options = {}, &block) click to toggle source

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

@example 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

@example 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

@example 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

@overload connect(connection_string, options = {})

    Used to pass connection parameters as a connection string
    @param [String] :connection_string AMQP connection URI, à la JDBC connection string. For example: amqp://bus.megacorp.internal:5877/qa

@overload connect(connection_options)

    Used to pass connection options as a Hash.
    @param [Hash] :connection_options AMQP connection options (:host, :port, :username, :vhost, :password)

@option connection_options_or_string [String] :host ("localhost") Host to connect to. @option connection_options_or_string [Integer] :port (5672) Port to connect to. @option connection_options_or_string [String] :vhost ("/") Virtual host to connect to. @option connection_options_or_string [String] :username ("guest") Username to use. Also can be specified as :user. @option connection_options_or_string [String] :password ("guest") Password to use. Also can be specified as :pass. @option connection_options_or_string [Hash] :ssl TLS (SSL) parameters to use. @option connection_options_or_string [Fixnum] :heartbeat (0) Connection heartbeat, in seconds. 0 means no heartbeat. Can also be configured server-side starting with RabbitMQ 3.0. @option connection_options_or_string [call] :on_tcp_connection_failure A callable object that will be run if connection to server fails @option connection_options_or_string [call] :on_possible_authentication_failure A callable object that will be run if authentication fails (see Authentication failure section)

h2. 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.

@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 {AMQP.start} instead.

    It takes exactly the same parameters.

@return [AMQP::Session] @api public

    # File lib/amqp/connection.rb, line 213
    def self.connect(connection_options_or_string = {}, other_options = {}, &block)
      Client.connect(connection_options_or_string, other_options, &block)
    end

connection() click to toggle source

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

@api public

    # File lib/amqp/connection.rb, line 102
    def self.connection
      @connection
    end

connection=(value) click to toggle source

Sets global connection object. @api public

    # File lib/amqp/connection.rb, line 128
    def self.connection=(value)
      @connection = value
    end

logging() click to toggle source

@return [Boolean] Current global logging value @api public

    # File lib/amqp/connection.rb, line 88
    def self.logging
      self.settings[:logging]
    end

logging=(value) click to toggle source

@return [Boolean] Sets current global logging value @api public

    # File lib/amqp/connection.rb, line 94
    def self.logging=(value)
      self.settings[:logging] = !!value
    end

run(*args, &block) click to toggle source

Alias for {AMQP.start} @api public

    # File lib/amqp/connection.rb, line 48
    def self.run(*args, &block)
      self.start(*args, &block)
    end

settings() click to toggle source

@return [Hash] Default AMQP connection settings. This hash may be modified. @api public

    # File lib/amqp/connection.rb, line 219
    def self.settings
      @settings ||= AMQ::Client::Settings.default
    end

start(connection_options_or_string = {}, other_options = {}, &block) click to toggle source

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

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

@example 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

@api public

    # File lib/amqp/connection.rb, line 36
    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

stop(reply_code = 200, reply_text = "Goodbye", &block) click to toggle source

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.

@note If default connection was never established or is in the closing state already,

    this method has no effect.

@api public

    # File lib/amqp/connection.rb, line 59
    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

[Validate]

Generated with the Darkfish Rdoc Generator 2.