amq-client 0.7.0.alpha34 → 0.7.0.alpha35

data/lib/amq/client/queue.rb

@@ -1,453 +1,8 @@
-# encoding: utf-8
-
-require "amq/client/entity"
-require "amq/client/adapter"
-require "amq/client/server_named_entity"
-require "amq/protocol/get_response"
+require "amq/client/async/queue"
 
 module AMQ
   module Client
-    class Queue
-
-      #
-      # Behaviors
-      #
-
-      include Entity
-      include ServerNamedEntity
-      extend ProtocolMethodHandlers
-
-
-      #
-      # API
-      #
-
-      # Qeueue name. May be server-generated or assigned directly.
-      attr_reader :name
-
-      # Channel this queue belongs to.
-      attr_reader :channel
-
-      # Consumer tag identifies subscription for message delivery. It is nil for queues that are not subscribed for messages. See AMQ::Client::Queue#subscribe.
-      attr_reader :consumer_tag
-
-      # @param  [AMQ::Client::Adapter]  AMQ networking adapter to use.
-      # @param  [AMQ::Client::Channel]  AMQ channel this queue object uses.
-      # @param  [String]                Queue name. Please note that AMQP spec does not require brokers to support Unicode for queue names.
-      # @api public
-      def initialize(connection, channel, name = AMQ::Protocol::EMPTY_STRING)
-        raise ArgumentError.new("queue name must not be nil; if you want broker to generate queue name for you, pass an empty string") if name.nil?
-
-        super(connection)
-
-        @name    = name
-        @channel = channel
-      end
-
-      def dup
-        if @name.empty?
-          raise RuntimeError.new("You can't clone anonymous queue until it receives server-generated name. Move the code with #dup to the callback for the #declare method.")
-        end
-
-        o = super
-        o.reset_consumer_tag!
-        o
-      end
-
-
-      # @return [Boolean] true if this queue was declared as durable (will survive broker restart).
-      # @api public
-      def durable?
-        @durable
-      end # durable?
-
-      # @return [Boolean] true if this queue was declared as exclusive (limited to just one consumer)
-      # @api public
-      def exclusive?
-        @exclusive
-      end # exclusive?
-
-      # @return [Boolean] true if this queue was declared as automatically deleted (deleted as soon as last consumer unbinds).
-      # @api public
-      def auto_delete?
-        @auto_delete
-      end # auto_delete?
-
-
-      # Declares this queue.
-      #
-      #
-      # @return [Queue]  self
-      #
-      # @api public
-      # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.7.2.1.)
-      def declare(passive = false, durable = false, exclusive = false, auto_delete = false, nowait = false, arguments = nil, &block)
-        raise ArgumentError, "declaration with nowait does not make sense for server-named queues! Either specify name other than empty string or use #declare without nowait" if nowait && self.anonymous?
-
-        @durable     = durable
-        @exclusive   = exclusive
-        @auto_delete = auto_delete
-
-        nowait = true if !block && !@name.empty?
-        @connection.send_frame(Protocol::Queue::Declare.encode(@channel.id, @name, passive, durable, exclusive, auto_delete, nowait, arguments))
-
-        if !nowait
-          self.append_callback(:declare, &block)
-          @channel.queues_awaiting_declare_ok.push(self)
-        end
-
-        self
-      end
-
-      # Deletes this queue.
-      #
-      # @param [Boolean] if_unused  delete only if queue has no consumers (subscribers).
-      # @param [Boolean] if_empty   delete only if queue has no messages in it.
-      # @param [Boolean] nowait     Don't wait for reply from broker.
-      # @return [Queue]  self
-      #
-      # @api public
-      # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.7.2.9.)
-      def delete(if_unused = false, if_empty = false, nowait = false, &block)
-        nowait = true unless block
-        @connection.send_frame(Protocol::Queue::Delete.encode(@channel.id, @name, if_unused, if_empty, nowait))
-
-        if !nowait
-          self.append_callback(:delete, &block)
-
-          # TODO: delete itself from queues cache
-          @channel.queues_awaiting_delete_ok.push(self)
-        end
-
-        self
-      end # delete(channel, queue, if_unused, if_empty, nowait, &block)
-
-      #
-      # @return [Queue]  self
-      #
-      # @api public
-      # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.7.2.3.)
-      def bind(exchange, routing_key = AMQ::Protocol::EMPTY_STRING, nowait = false, arguments = nil, &block)
-        nowait = true unless block
-        exchange_name = if exchange.respond_to?(:name)
-                          exchange.name
-                        else
-
-                          exchange
-                        end
-
-        @connection.send_frame(Protocol::Queue::Bind.encode(@channel.id, @name, exchange_name, routing_key, nowait, arguments))
-
-        if !nowait
-          self.append_callback(:bind, &block)
-
-          # TODO: handle channel & connection-level exceptions
-          @channel.queues_awaiting_bind_ok.push(self)
-        end
-
-        self
-      end
-
-      #
-      # @return [Queue]  self
-      #
-      # @api public
-      # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.7.2.5.)
-      def unbind(exchange, routing_key = AMQ::Protocol::EMPTY_STRING, arguments = nil, &block)
-        exchange_name = if exchange.respond_to?(:name)
-                          exchange.name
-                        else
-
-                          exchange
-                        end
-
-        @connection.send_frame(Protocol::Queue::Unbind.encode(@channel.id, @name, exchange_name, routing_key, arguments))
-
-        self.append_callback(:unbind, &block)
-        # TODO: handle channel & connection-level exceptions
-        @channel.queues_awaiting_unbind_ok.push(self)
-
-        self
-      end
-
-
-      #
-      # @return [Queue]  self
-      #
-      # @api public
-      # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.8.3.3.)
-      def consume(no_ack = false, exclusive = false, nowait = false, no_local = false, arguments = nil, &block)
-        raise RuntimeError.new("This instance is already being consumed! Create another one using #dup.") if @consumer_tag
-
-        nowait        = true unless block
-        @consumer_tag = generate_consumer_tag(name)
-        @connection.send_frame(Protocol::Basic::Consume.encode(@channel.id, @name, @consumer_tag, no_local, no_ack, exclusive, nowait, arguments))
-
-        @channel.consumers[@consumer_tag] = self
-
-        if !nowait
-          # unlike #get, here it is reasonable to expect more than one callback
-          # so we use #append_callback
-          self.append_callback(:consume, &block)
-
-          @channel.queues_awaiting_consume_ok.push(self)
-        end
-
-        self
-      end
-
-      # Unique string supposed to be used as a consumer tag.
-      #
-      # @return [String]  Unique string.
-      # @api plugin
-      def generate_consumer_tag(name)
-        "#{name}-#{Time.now.to_i * 1000}-#{Kernel.rand(999_999_999_999)}"
-      end
-
-      # Resets consumer tag by setting it to nil.
-      # @return [String]  Consumer tag this queue previously used.
-      #
-      # @api plugin
-      def reset_consumer_tag!
-        ct = @consumer_tag.dup
-        @consumer_tag = nil
-
-        ct
-      end
-
-
-      #
-      # @return [Queue]  self
-      #
-      # @api public
-      # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.8.3.10.)
-      def get(no_ack = false, &block)
-        @connection.send_frame(Protocol::Basic::Get.encode(@channel.id, @name, no_ack))
-
-        # most people only want one callback per #get call. Consider the following example:
-        #
-        # 100.times { queue.get { ... } }
-        #
-        # most likely you won't expect 100 callback runs per message here. MK.
-        self.redefine_callback(:get, &block)
-        @channel.queues_awaiting_get_response.push(self)
-
-        self
-      end # get(no_ack = false, &block)
-
-      #
-      # @return [Queue]  self
-      #
-      # @api public
-      # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.8.3.5.)
-      def cancel(nowait = false, &block)
-        raise "There is no consumer tag for this queue. This usually means that you are trying to unsubscribe a queue that never was subscribed for messages in the first place." if @consumer_tag.nil?
-
-        @connection.send_frame(Protocol::Basic::Cancel.encode(@channel.id, @consumer_tag, nowait))
-        @consumer_tag = nil
-        self.clear_callbacks(:delivery)
-        self.clear_callbacks(:consume)
-
-        if !nowait
-          self.redefine_callback(:cancel, &block)
-          @channel.queues_awaiting_cancel_ok.push(self)
-        end
-
-        self
-      end # cancel(&block)
-
-      #
-      # @return [Queue]  self
-      #
-      # @api public
-      # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.7.2.7.)
-      def purge(nowait = false, &block)
-        nowait = true unless block
-        @connection.send_frame(Protocol::Queue::Purge.encode(@channel.id, @name, nowait))
-
-        if !nowait
-          self.redefine_callback(:purge, &block)
-          # TODO: handle channel & connection-level exceptions
-          @channel.queues_awaiting_purge_ok.push(self)
-        end
-
-        self
-      end # purge(nowait = false, &block)
-
-      #
-      # @return [Queue]  self
-      #
-      # @api public
-      # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.8.3.13.)
-      def acknowledge(delivery_tag)
-        @channel.acknowledge(delivery_tag)
-
-        self
-      end # acknowledge(delivery_tag)
-
-      #
-      # @return [Queue]  self
-      #
-      # @api public
-      # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Section 1.8.3.14.)
-      def reject(delivery_tag, requeue = true)
-        @channel.reject(delivery_tag, requeue)
-
-        self
-      end # reject(delivery_tag, requeue = true)
-
-
-
-      # @api public
-      # @see http://bit.ly/htCzCX AMQP 0.9.1 protocol documentation (Sections 1.8.3.9)
-      def on_delivery(&block)
-        self.append_callback(:delivery, &block)
-      end # on_delivery(&block)
-
-
-
-      #
-      # Implementation
-      #
-
-      def handle_declare_ok(method)
-        @name = method.queue if self.anonymous?
-        @channel.register_queue(self)
-
-        self.exec_callback_once_yielding_self(:declare, method)
-      end
-
-      def handle_delete_ok(method)
-        self.exec_callback_once(:delete, method)
-      end # handle_delete_ok(method)
-
-      def handle_consume_ok(method)
-        self.exec_callback_once(:consume, method)
-      end # handle_consume_ok(method)
-
-      def handle_purge_ok(method)
-        self.exec_callback_once(:purge, method)
-      end # handle_purge_ok(method)
-
-      def handle_bind_ok(method)
-        self.exec_callback_once(:bind, method)
-      end # handle_bind_ok(method)
-
-      def handle_unbind_ok(method)
-        self.exec_callback_once(:unbind, method)
-      end # handle_unbind_ok(method)
-
-      def handle_delivery(method, header, payload)
-        self.exec_callback(:delivery, method, header, payload)
-      end # handle_delivery
-
-      def handle_cancel_ok(method)
-        @consumer_tag = nil
-        self.exec_callback_once(:cancel, method)
-      end # handle_cancel_ok(method)
-
-      def handle_get_ok(method, header, payload)
-        method = Protocol::GetResponse.new(method)
-        self.exec_callback(:get, method, header, payload)
-      end # handle_get_ok(method, header, payload)
-
-      def handle_get_empty(method)
-        method = Protocol::GetResponse.new(method)
-        self.exec_callback(:get, method)
-      end # handle_get_empty(method)
-
-
-
-      # Get the first queue which didn't receive Queue.Declare-Ok yet and run its declare callback.
-      # The cache includes only queues with {nowait: false}.
-      self.handle(Protocol::Queue::DeclareOk) do |connection, frame|
-        method  = frame.decode_payload
-
-        channel = connection.channels[frame.channel]
-        queue   = channel.queues_awaiting_declare_ok.shift
-
-        queue.handle_declare_ok(method)
-      end
-
-
-      self.handle(Protocol::Queue::DeleteOk) do |connection, frame|
-        channel = connection.channels[frame.channel]
-        queue   = channel.queues_awaiting_delete_ok.shift
-        queue.handle_delete_ok(frame.decode_payload)
-      end
-
-
-      self.handle(Protocol::Queue::BindOk) do |connection, frame|
-        channel = connection.channels[frame.channel]
-        queue   = channel.queues_awaiting_bind_ok.shift
-
-        queue.handle_bind_ok(frame.decode_payload)
-      end
-
-
-      self.handle(Protocol::Queue::UnbindOk) do |connection, frame|
-        channel = connection.channels[frame.channel]
-        queue   = channel.queues_awaiting_unbind_ok.shift
-
-        queue.handle_unbind_ok(frame.decode_payload)
-      end
-
-
-      self.handle(Protocol::Basic::ConsumeOk) do |connection, frame|
-        channel = connection.channels[frame.channel]
-        queue   = channel.queues_awaiting_consume_ok.shift
-
-        queue.handle_consume_ok(frame.decode_payload)
-      end
-
-
-      self.handle(Protocol::Basic::CancelOk) do |connection, frame|
-        channel = connection.channels[frame.channel]
-        queue   = channel.queues_awaiting_cancel_ok.shift
-
-        queue.handle_consume_ok(frame.decode_payload)
-      end
-
-
-      # Basic.Deliver
-      self.handle(Protocol::Basic::Deliver) do |connection, method_frame, content_frames|
-        channel  = connection.channels[method_frame.channel]
-        method   = method_frame.decode_payload
-        queue    = channel.consumers[method.consumer_tag]
-
-        header = content_frames.shift
-        body   = content_frames.map { |frame| frame.payload }.join
-        queue.handle_delivery(method, header, body)
-        # TODO: ack if necessary
-      end
-
-
-      self.handle(Protocol::Queue::PurgeOk) do |connection, frame|
-        channel = connection.channels[frame.channel]
-        queue   = channel.queues_awaiting_purge_ok.shift
-
-        queue.handle_purge_ok(frame.decode_payload)
-      end
-
-
-      self.handle(Protocol::Basic::GetOk) do |connection, frame, content_frames|
-        channel = connection.channels[frame.channel]
-        queue   = channel.queues_awaiting_get_response.shift
-        method  = frame.decode_payload
-
-        header  = content_frames.shift
-        body    = content_frames.map {|frame| frame.payload }.join
-
-        queue.handle_get_ok(method, header, body) if queue
-      end
-
-
-      self.handle(Protocol::Basic::GetEmpty) do |connection, frame|
-        channel = connection.channels[frame.channel]
-        queue   = channel.queues_awaiting_get_response.shift
-
-        queue.handle_get_empty(frame.decode_payload)
-      end
-    end # Queue
-  end # Client
-end # AMQ
+    Queue = Async::Queue
+  end
+end
+