For overview of AMQP client adapters API, see {AMQ::Client::Adapter}
For overview of AMQP client adapters API, see {AMQ::Client::Adapter}
backwards compatibility @private
backwards compatibility @private
backwards compatibility @private
backwards compatibility @private
backwards compatibility @private
backwards compatibility @private
backwards compatibility @private
backwards compatibility @private
backwards compatibility @private
List available adapters as a hash of { :adapter_name => metadata }, where metadata are hash with :path and :const_name keys.
@return [Hash] @api plugin
# File lib/amq/client.rb, line 28 28: def self.adapters 29: @adapters ||= (self.async_adapters) 30: end
List available asynchronous adapters.
@return [Hash] @api plugin @see AMQ::Client.adapters
# File lib/amq/client.rb, line 37 37: def self.async_adapters 38: @async_adapters ||= { 39: :eventmachine => { 40: :path => "amq/client/async/adapters/eventmachine", 41: :const_name => "Async::EventMachineClient" 42: }, 43: :event_machine => { 44: :path => "amq/client/async/adapters/eventmachine", 45: :const_name => "Async::EventMachineClient" 46: }, 47: :coolio => { 48: :path => "amq/client/async/adapters/coolio", 49: :const_name => "Async::CoolioClient" 50: } 51: } 52: end
Establishes connection to AMQ broker using given adapter (defaults to the socket adapter) and returns it. The new connection object is yielded to the block if it is given.
@example
AMQ::Client.connect(adapter: "socket") do |client| # Use the client. end
@param [Hash] Connection parameters, including :adapter to use. @api public
# File lib/amq/client.rb, line 65 65: def self.connect(settings = nil, &block) 66: adapter = (settings && settings.delete(:adapter)) 67: adapter = load_adapter(adapter) 68: adapter.connect(settings, &block) 69: end
Loads adapter given its name as a Symbol.
@raise [InvalidAdapterNameError] When loading attempt failed (LoadError was raised).
# File lib/amq/client.rb, line 74 74: def self.load_adapter(adapter) 75: meta = self.adapters[adapter.to_sym] 76: 77: require meta[:path] 78: eval(meta[:const_name]) 79: rescue LoadError 80: raise InvalidAdapterNameError.new(adapter) 81: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.