amqp-client 1.0.2 → 1.1.0

data/lib/amqp/client/frames.rb

@@ -10,9 +10,7 @@ module AMQP
     # Having a class for each frame type is more expensive in terms of CPU and memory
     # @api private
     module FrameBytes
-      module_function
-
-      def connection_start_ok(response, properties)
+      def self.connection_start_ok(response, properties)
         prop_tbl = Table.encode(properties)
         [
           1, # type: method
@@ -28,7 +26,7 @@ module AMQP
         ].pack("C S> L> S> S> L>a* Ca* L>a* Ca* C")
       end
 
-      def connection_tune_ok(channel_max, frame_max, heartbeat)
+      def self.connection_tune_ok(channel_max, frame_max, heartbeat)
         [
           1, # type: method
           0, # channel id
@@ -42,7 +40,7 @@ module AMQP
         ].pack("CS>L>S>S>S>L>S>C")
       end
 
-      def connection_open(vhost)
+      def self.connection_open(vhost)
         [
           1, # type: method
           0, # channel id
@@ -56,7 +54,7 @@ module AMQP
         ].pack("C S> L> S> S> Ca* CCC")
       end
 
-      def connection_close(code, reason)
+      def self.connection_close(code, reason)
         frame_size = 2 + 2 + 2 + 1 + reason.bytesize + 2 + 2
         [
           1, # type: method
@@ -72,7 +70,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* S> S> C")
       end
 
-      def connection_close_ok
+      def self.connection_close_ok
         [
           1, # type: method
           0, # channel id
@@ -83,7 +81,7 @@ module AMQP
         ].pack("C S> L> S> S> C")
       end
 
-      def channel_open(id)
+      def self.channel_open(id)
         [
           1, # type: method
           id, # channel id
@@ -95,7 +93,7 @@ module AMQP
         ].pack("C S> L> S> S> C C")
       end
 
-      def channel_close(id, reason, code)
+      def self.channel_close(id, reason, code)
         frame_size = 2 + 2 + 2 + 1 + reason.bytesize + 2 + 2
         [
           1, # type: method
@@ -111,7 +109,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* S> S> C")
       end
 
-      def channel_close_ok(id)
+      def self.channel_close_ok(id)
         [
           1, # type: method
           id, # channel id
@@ -122,7 +120,7 @@ module AMQP
         ].pack("C S> L> S> S> C")
       end
 
-      def exchange_declare(id, name, type, passive, durable, auto_delete, internal, arguments)
+      def self.exchange_declare(id, name, type, passive, durable, auto_delete, internal, arguments)
         no_wait = false
         bits = 0
         bits |= (1 << 0) if passive
@@ -147,7 +145,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* Ca* C L>a* C")
       end
 
-      def exchange_delete(id, name, if_unused, no_wait)
+      def self.exchange_delete(id, name, if_unused, no_wait)
         bits = 0
         bits |= (1 << 0) if if_unused
         bits |= (1 << 1) if no_wait
@@ -165,7 +163,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* C C")
       end
 
-      def exchange_bind(id, destination, source, binding_key, no_wait, arguments)
+      def self.exchange_bind(id, destination, source, binding_key, no_wait, arguments)
         tbl = Table.encode(arguments)
         frame_size = 2 + 2 + 2 + 1 + destination.bytesize + 1 + source.bytesize + 1 +
                      binding_key.bytesize + 1 + 4 + tbl.bytesize
@@ -185,7 +183,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* Ca* Ca* C L>a* C")
       end
 
-      def exchange_unbind(id, destination, source, binding_key, no_wait, arguments)
+      def self.exchange_unbind(id, destination, source, binding_key, no_wait, arguments)
         tbl = Table.encode(arguments)
         frame_size = 2 + 2 + 2 + 1 + destination.bytesize + 1 + source.bytesize + 1 +
                      binding_key.bytesize + 1 + 4 + tbl.bytesize
@@ -205,7 +203,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* Ca* Ca* C L>a* C")
       end
 
-      def queue_declare(id, name, passive, durable, exclusive, auto_delete, arguments)
+      def self.queue_declare(id, name, passive, durable, exclusive, auto_delete, arguments)
         no_wait = false
         bits = 0
         bits |= (1 << 0) if passive
@@ -229,7 +227,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* C L>a* C")
       end
 
-      def queue_delete(id, name, if_unused, if_empty, no_wait)
+      def self.queue_delete(id, name, if_unused, if_empty, no_wait)
         bits = 0
         bits |= (1 << 0) if if_unused
         bits |= (1 << 1) if if_empty
@@ -248,7 +246,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* C C")
       end
 
-      def queue_bind(id, queue, exchange, binding_key, no_wait, arguments)
+      def self.queue_bind(id, queue, exchange, binding_key, no_wait, arguments)
         tbl = Table.encode(arguments)
         frame_size = 2 + 2 + 2 + 1 + queue.bytesize + 1 + exchange.bytesize + 1 +
                      binding_key.bytesize + 1 + 4 + tbl.bytesize
@@ -268,7 +266,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* Ca* Ca* C L>a* C")
       end
 
-      def queue_unbind(id, queue, exchange, binding_key, arguments)
+      def self.queue_unbind(id, queue, exchange, binding_key, arguments)
         tbl = Table.encode(arguments)
         frame_size = 2 + 2 + 2 + 1 + queue.bytesize + 1 + exchange.bytesize + 1 +
                      binding_key.bytesize + 4 + tbl.bytesize
@@ -287,7 +285,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* Ca* Ca* L>a* C")
       end
 
-      def queue_purge(id, queue, no_wait)
+      def self.queue_purge(id, queue, no_wait)
         frame_size = 2 + 2 + 2 + 1 + queue.bytesize + 1
         [
           1, # type: method
@@ -302,7 +300,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* C C")
       end
 
-      def basic_get(id, queue, no_ack)
+      def self.basic_get(id, queue, no_ack)
         frame_size = 2 + 2 + 2 + 1 + queue.bytesize + 1
         [
           1, # type: method
@@ -317,7 +315,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* C C")
       end
 
-      def basic_publish(id, exchange, routing_key, mandatory)
+      def self.basic_publish(id, exchange, routing_key, mandatory)
         frame_size = 2 + 2 + 2 + 1 + exchange.bytesize + 1 + routing_key.bytesize + 1
         [
           1, # type: method
@@ -333,7 +331,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* Ca* C C")
       end
 
-      def header(id, body_size, properties)
+      def self.header(id, body_size, properties)
         props = Properties.new(**properties).encode
         frame_size = 2 + 2 + 8 + props.bytesize
         [
@@ -348,7 +346,7 @@ module AMQP
         ].pack("C S> L> S> S> Q> a* C")
       end
 
-      def body(id, body_part)
+      def self.body(id, body_part)
         [
           3, # type: body
           id, # channel id
@@ -358,7 +356,7 @@ module AMQP
         ].pack("C S> L> a* C")
       end
 
-      def basic_consume(id, queue, tag, no_ack, exclusive, arguments)
+      def self.basic_consume(id, queue, tag, no_ack, exclusive, arguments)
         no_local = false
         no_wait = false
         bits = 0
@@ -383,7 +381,7 @@ module AMQP
         ].pack("C S> L> S> S> S> Ca* Ca* C L>a* C")
       end
 
-      def basic_cancel(id, consumer_tag, no_wait: false)
+      def self.basic_cancel(id, consumer_tag, no_wait: false)
         frame_size = 2 + 2 + 1 + consumer_tag.bytesize + 1
         [
           1, # type: method
@@ -397,7 +395,7 @@ module AMQP
         ].pack("C S> L> S> S> Ca* C C")
       end
 
-      def basic_cancel_ok(id, consumer_tag)
+      def self.basic_cancel_ok(id, consumer_tag)
         frame_size = 2 + 2 + 1 + consumer_tag.bytesize + 1
         [
           1, # type: method
@@ -410,7 +408,7 @@ module AMQP
         ].pack("C S> L> S> S> Ca* C")
       end
 
-      def basic_ack(id, delivery_tag, multiple)
+      def self.basic_ack(id, delivery_tag, multiple)
         frame_size = 2 + 2 + 8 + 1
         [
           1, # type: method
@@ -424,7 +422,7 @@ module AMQP
         ].pack("C S> L> S> S> Q> C C")
       end
 
-      def basic_nack(id, delivery_tag, multiple, requeue)
+      def self.basic_nack(id, delivery_tag, multiple, requeue)
         bits = 0
         bits |= (1 << 0) if multiple
         bits |= (1 << 1) if requeue
@@ -441,7 +439,7 @@ module AMQP
         ].pack("C S> L> S> S> Q> C C")
       end
 
-      def basic_reject(id, delivery_tag, requeue)
+      def self.basic_reject(id, delivery_tag, requeue)
         frame_size = 2 + 2 + 8 + 1
         [
           1, # type: method
@@ -455,7 +453,7 @@ module AMQP
         ].pack("C S> L> S> S> Q> C C")
       end
 
-      def basic_qos(id, prefetch_size, prefetch_count, global)
+      def self.basic_qos(id, prefetch_size, prefetch_count, global)
         frame_size = 2 + 2 + 4 + 2 + 1
         [
           1, # type: method
@@ -470,7 +468,7 @@ module AMQP
         ].pack("C S> L> S> S> L> S> C C")
       end
 
-      def basic_recover(id, requeue)
+      def self.basic_recover(id, requeue)
         frame_size = 2 + 2 + 1
         [
           1, # type: method
@@ -483,7 +481,7 @@ module AMQP
         ].pack("C S> L> S> S> C C")
       end
 
-      def confirm_select(id, no_wait)
+      def self.confirm_select(id, no_wait)
         [
           1, # type: method
           id, # channel id
@@ -495,7 +493,7 @@ module AMQP
         ].pack("C S> L> S> S> C C")
       end
 
-      def tx_select(id)
+      def self.tx_select(id)
         frame_size = 2 + 2
         [
           1, # type: method
@@ -507,7 +505,7 @@ module AMQP
         ].pack("C S> L> S> S> C")
       end
 
-      def tx_commit(id)
+      def self.tx_commit(id)
         frame_size = 2 + 2
         [
           1, # type: method
@@ -519,7 +517,7 @@ module AMQP
         ].pack("C S> L> S> S> C")
       end
 
-      def tx_rollback(id)
+      def self.tx_rollback(id)
         frame_size = 2 + 2
         [
           1, # type: method

data/lib/amqp/client/message.rb

@@ -3,52 +3,109 @@
 module AMQP
   class Client
     # A message delivered from the broker
-    # @!attribute channel
-    #   @return [Connection::Channel] The channel the message was deliviered to
-    # @!attribute delivery_tag
-    #   @return [Integer] The delivery tag of the message, used for acknowledge or reject the message
-    # @!attribute exchange_name
-    #   @return [String] Name of the exchange the message was published to
-    # @!attribute routing_key
-    #   @return [String] The routing key the message was published with
-    # @!attribute properties
-    #   @return [Properties]
-    # @!attribute body
-    #   @return [String] The message body
-    # @!attribute redelivered
-    #   @return [Boolean] True if the message have been delivered before
-    # @!attribute consumer_tag
-    #   @return [String] The tag of the consumer the message was deliviered to
-    #   @return [nil] Nil if the message was polled and not deliviered to a consumer
-    Message =
-      Struct.new(:channel, :delivery_tag, :exchange_name, :routing_key, :properties, :body, :redelivered, :consumer_tag) do
-        # Acknowledge the message
-        # @return [nil]
-        def ack
-          channel.basic_ack(delivery_tag)
-        end
-
-        # Reject the message
-        # @param requeue [Boolean] If true the message will be put back into the queue again, ready to be redelivered
-        # @return [nil]
-        def reject(requeue: false)
-          channel.basic_reject(delivery_tag, requeue: requeue)
-        end
+    class Message
+      # @api private
+      def initialize(channel, consumer_tag, delivery_tag, exchange, routing_key, redelivered)
+        @channel = channel
+        @consumer_tag = consumer_tag
+        @delivery_tag = delivery_tag
+        @exchange = exchange
+        @routing_key = routing_key
+        @redelivered = redelivered
+        @properties = nil
+        @body = ""
       end
 
+      # The channel the message was deliviered to
+      # @return [Connection::Channel]
+      attr_reader :channel
+
+      # The tag of the consumer the message was deliviered to
+      # @return [String]
+      # @return [nil] If the message was polled and not deliviered to a consumer
+      attr_reader :consumer_tag
+
+      # The delivery tag of the message, used for acknowledge or reject the message
+      # @return [Integer]
+      attr_reader :delivery_tag
+
+      # Name of the exchange the message was published to
+      # @return [String]
+      attr_reader :exchange
+
+      # The routing key the message was published with
+      # @return [String]
+      attr_reader :routing_key
+
+      # True if the message have been delivered before
+      # @return [Boolean]
+      attr_reader :redelivered
+
+      # Message properties
+      # @return [Properties]
+      attr_accessor :properties
+
+      # The message body
+      # @return [String]
+      attr_accessor :body
+
+      # Acknowledge the message
+      # @return [nil]
+      def ack
+        @channel.basic_ack(@delivery_tag)
+      end
+
+      # Reject the message
+      # @param requeue [Boolean] If true the message will be put back into the queue again, ready to be redelivered
+      # @return [nil]
+      def reject(requeue: false)
+        @channel.basic_reject(@delivery_tag, requeue: requeue)
+      end
+
+      # @see #exchange
+      # @deprecated
+      # @!attribute [r] exchange_name
+      # @return [String]
+      def exchange_name
+        @exchange
+      end
+    end
+
     # A published message returned by the broker due to some error
-    # @!attribute reply_code
-    #   @return [Integer] Error code
-    # @!attribute reply_text
-    #   @return [String] Description on why the message was returned
-    # @!attribute exchange
-    #   @return [String] Name of the exchange the message was published to
-    # @!attribute routing_key
-    #   @return [String] The routing key the message was published with
-    # @!attribute properties
-    #   @return [Properties]
-    # @!attribute body
-    #   @return [String] The message body
-    ReturnMessage = Struct.new(:reply_code, :reply_text, :exchange, :routing_key, :properties, :body)
+    class ReturnMessage
+      # @api private
+      def initialize(reply_code, reply_text, exchange, routing_key)
+        @reply_code = reply_code
+        @reply_text = reply_text
+        @exchange = exchange
+        @routing_key = routing_key
+        @properties = nil
+        @body = ""
+      end
+
+      # Error code
+      # @return [Integer]
+      attr_reader :reply_code
+
+      # Description on why the message was returned
+      # @return [String]
+      attr_reader :reply_text
+
+      # Name of the exchange the message was published to
+      # @return [String]
+      attr_reader :exchange
+
+      # The routing key the message was published with
+      # @return [String]
+      attr_reader :routing_key
+
+      # Message properties
+      # @return [Properties]
+      attr_accessor :properties
+
+      # The message body
+      # @return [String]
+      attr_accessor :body
+    end
   end
 end

data/lib/amqp/client/properties.rb

@@ -5,35 +5,65 @@ require_relative "./table"
 module AMQP
   class Client
     # Encode/decode AMQP Properties
-    # @!attribute content_type
-    #   @return [String] Content type of the message body
-    # @!attribute content_encoding
-    #   @return [String] Content encoding of the body
-    # @!attribute headers
-    #   @return [Hash<String, Object>] Custom headers
-    # @!attribute delivery_mode
-    #   @return [Integer] 2 for persisted message, transient messages for all other values
-    # @!attribute priority
-    #   @return [Integer] A priority of the message (between 0 and 255)
-    # @!attribute correlation_id
-    #   @return [Integer] A correlation id, most often used used for RPC communication
-    # @!attribute reply_to
-    #   @return [String] Queue to reply RPC responses to
-    # @!attribute expiration
-    #   @return [Integer, String] Number of seconds the message will stay in the queue
-    # @!attribute message_id
-    #   @return [String]
-    # @!attribute timestamp
-    #   @return [Date] User-definable, but often used for the time the message was originally generated
-    # @!attribute type
-    #   @return [String] User-definable, but can can indicate what kind of message this is
-    # @!attribute user_id
-    #   @return [String] User-definable, but can be used to verify that this is the user that published the message
-    # @!attribute app_id
-    #   @return [String] User-definable, but often indicates which app that generated the message
-    Properties = Struct.new(:content_type, :content_encoding, :headers, :delivery_mode, :priority, :correlation_id,
-                            :reply_to, :expiration, :message_id, :timestamp, :type, :user_id, :app_id,
-                            keyword_init: true) do
+    class Properties
+      def initialize(content_type: nil, content_encoding: nil, headers: nil, delivery_mode: nil, priority: nil, correlation_id: nil,
+                     reply_to: nil, expiration: nil, message_id: nil, timestamp: nil, type: nil, user_id: nil, app_id: nil)
+        @content_type = content_type
+        @content_encoding = content_encoding
+        @headers = headers
+        @delivery_mode = delivery_mode
+        @priority = priority
+        @correlation_id = correlation_id
+        @reply_to = reply_to
+        @expiration = expiration
+        @message_id = message_id
+        @timestamp = timestamp
+        @type = type
+        @user_id = user_id
+        @app_id = app_id
+      end
+
+      # Content type of the message body
+      # @return [String, nil]
+      attr_accessor :content_type
+      # Content encoding of the body
+      # @return [String, nil]
+      attr_accessor :content_encoding
+      # Custom headers
+      # @return [Hash<String, Object>, nil]
+      attr_accessor :headers
+      # 2 for persisted message, transient messages for all other values
+      # @return [Integer, nil]
+      attr_accessor :delivery_mode
+      # A priority of the message (between 0 and 255)
+      # @return [Integer, nil]
+      attr_accessor :priority
+      # A correlation id, most often used used for RPC communication
+      # @return [Integer, nil]
+      attr_accessor :correlation_id
+      # Queue to reply RPC responses to
+      # @return [String, nil]
+      attr_accessor :reply_to
+      # Number of seconds the message will stay in the queue
+      # @return [Integer]
+      # @return [String]
+      # @return [nil]
+      attr_accessor :expiration
+      # @return [String, nil]
+      attr_accessor :message_id
+      # User-definable, but often used for the time the message was originally generated
+      # @return [Date, nil]
+      attr_accessor :timestamp
+      # User-definable, but can can indicate what kind of message this is
+      # @return [String, nil]
+      attr_accessor :type
+      # User-definable, but can be used to verify that this is the user that published the message
+      # @return [String, nil]
+      attr_accessor :user_id
+      # User-definable, but often indicates which app that generated the message
+      # @return [String, nil]
+      attr_accessor :app_id
+
       # Encode properties into a byte array
       # @return [String] byte array
       def encode
@@ -155,81 +185,81 @@ module AMQP
       # Decode a byte array
       # @return [Properties]
       def self.decode(bytes)
-        h = new
+        p = new
         flags = bytes.unpack1("S>")
         pos = 2
         if (flags & 0x8000).positive?
-          len = bytes[pos].ord
+          len = bytes.getbyte(pos)
           pos += 1
-          h[:content_type] = bytes.byteslice(pos, len).force_encoding("utf-8")
+          p.content_type = bytes.byteslice(pos, len).force_encoding("utf-8")
           pos += len
         end
         if (flags & 0x4000).positive?
-          len = bytes[pos].ord
+          len = bytes.getbyte(pos)
           pos += 1
-          h[:content_encoding] = bytes.byteslice(pos, len).force_encoding("utf-8")
+          p.content_encoding = bytes.byteslice(pos, len).force_encoding("utf-8")
           pos += len
         end
         if (flags & 0x2000).positive?
           len = bytes.byteslice(pos, 4).unpack1("L>")
           pos += 4
-          h[:headers] = Table.decode(bytes.byteslice(pos, len))
+          p.headers = Table.decode(bytes.byteslice(pos, len))
           pos += len
         end
         if (flags & 0x1000).positive?
-          h[:delivery_mode] = bytes[pos].ord
+          p.delivery_mode = bytes.getbyte(pos)
           pos += 1
         end
         if (flags & 0x0800).positive?
-          h[:priority] = bytes[pos].ord
+          p.priority = bytes.getbyte(pos)
           pos += 1
         end
         if (flags & 0x0400).positive?
-          len = bytes[pos].ord
+          len = bytes.getbyte(pos)
           pos += 1
-          h[:correlation_id] = bytes.byteslice(pos, len).force_encoding("utf-8")
+          p.correlation_id = bytes.byteslice(pos, len).force_encoding("utf-8")
           pos += len
         end
         if (flags & 0x0200).positive?
-          len = bytes[pos].ord
+          len = bytes.getbyte(pos)
           pos += 1
-          h[:reply_to] = bytes.byteslice(pos, len).force_encoding("utf-8")
+          p.reply_to = bytes.byteslice(pos, len).force_encoding("utf-8")
           pos += len
         end
         if (flags & 0x0100).positive?
-          len = bytes[pos].ord
+          len = bytes.getbyte(pos)
           pos += 1
-          h[:expiration] = bytes.byteslice(pos, len).force_encoding("utf-8")
+          p.expiration = bytes.byteslice(pos, len).force_encoding("utf-8")
           pos += len
         end
         if (flags & 0x0080).positive?
-          len = bytes[pos].ord
+          len = bytes.getbyte(pos)
           pos += 1
-          h[:message_id] = bytes.byteslice(pos, len).force_encoding("utf-8")
+          p.message_id = bytes.byteslice(pos, len).force_encoding("utf-8")
           pos += len
         end
         if (flags & 0x0040).positive?
-          h[:timestamp] = Time.at(bytes.byteslice(pos, 8).unpack1("Q>"))
+          p.timestamp = Time.at(bytes.byteslice(pos, 8).unpack1("Q>"))
           pos += 8
         end
         if (flags & 0x0020).positive?
-          len = bytes[pos].ord
+          len = bytes.getbyte(pos)
           pos += 1
-          h[:type] = bytes.byteslice(pos, len).force_encoding("utf-8")
+          p.type = bytes.byteslice(pos, len).force_encoding("utf-8")
           pos += len
         end
         if (flags & 0x0010).positive?
-          len = bytes[pos].ord
+          len = bytes.getbyte(pos)
           pos += 1
-          h[:user_id] = bytes.byteslice(pos, len).force_encoding("utf-8")
+          p.user_id = bytes.byteslice(pos, len).force_encoding("utf-8")
           pos += len
         end
         if (flags & 0x0008).positive?
-          len = bytes[pos].ord
+          len = bytes.getbyte(pos)
           pos += 1
-          h[:app_id] = bytes.byteslice(pos, len).force_encoding("utf-8")
+          p.app_id = bytes.byteslice(pos, len).force_encoding("utf-8")
         end
-        h
+        p
       end
     end
   end