march_hare 4.6.0-java → 4.7.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f3076067130e44a2c49fc4789b38d15b18ab7c4ca01ad19cc5d9c45d0ac0242
-  data.tar.gz: 8cbdeb88ff5e273620158933104deab45a450afd1ef2cc193e6e48b7661ce4b3
+  metadata.gz: dbcc08d76c936d48219df49aeb1e42b7495d20151ff4acea5441bb3bcd4834c0
+  data.tar.gz: 1a49f5a57d3d118ef6d099ac35a181199afb300458a67fe8f6b47cb1e7c8e394
 SHA512:
-  metadata.gz: 2f2e7d323e3e212bc51c98df47ce6311dfa2f0e47eac07ba75dd229a5ed20be2af590cbf356f2547fe9ec6a8f682c6e0d6101cd0f6503863cb2b5a9e2d81a5a1
-  data.tar.gz: a432d8e6ef0d5d2df4cc552edaa4a4215e9dfe62b99bf4eb0f30a56b5fb59db4619cf5fe829a7ec1507d490f7140e0d79737d5f1b25f23acde1c11f9a2905e23
+  metadata.gz: 52c1ca909abfe296dc53ed64ff4da122a93bdec28ee141a190317cd5681ef9c8db2a2170fa0cfc97077012766f0cd9eefcb9318750dbe6259f89eea320217201
+  data.tar.gz: adefc87af6121d7e7c4fdec9d49fdbeb62aaf0a4ac4247b9d86c704b83822b8714baca7bb9a5ddec79ac37c862505bd94243f4b08e21682c84265a6cbde8da26

data/lib/march_hare/channel.rb

@@ -132,6 +132,11 @@ module MarchHare
       @confirm_hooks  = Array.new
       @recoveries_counter = JavaConcurrent::AtomicInteger.new(0)
 
+      # An opt-in setting that instructs the channel to cancel all consumers
+      # before closing. This helps reduce the probability of in-flight deliveries
+      # right before channel closure.
+      @cancel_consumers_before_closing = false
+
       on_shutdown do |ch, cause|
         ch.gracefully_shut_down_consumers
       end
@@ -161,12 +166,33 @@ module MarchHare
       @delegate.open?
     end
 
+    def closed?
+      !open?
+    end
+
     # Closes the channel.
     #
     # Closed channels can no longer be used. Closed channel id is
     # returned back to the pool of available ids and may be used by
     # a different channel opened later.
     def close(code = 200, reason = "Goodbye")
+      # This is a best-effort attempt to cancel all consumers before closing the channel.
+      # Retries are extremely unlikely to succeed, and the channel itself is about to be closed,
+      # so we don't bother retrying.
+      if self.cancel_consumers_before_closing?
+       # cancelling a consumer involves using the same mutex, so avoid holding the lock
+        keys = @consumers.keys
+        keys.each do |ctag|
+          begin
+            self.basic_cancel(ctag)
+          rescue Bunny::Exception
+            # ignore
+          rescue Bunny::ClientTimeout
+            # ignore
+          end
+        end
+      end
+
       v = @delegate.close(code, reason)
 
       @consumers.each do |tag, consumer|
@@ -178,6 +204,21 @@ module MarchHare
       v
     end
 
+
+    def configure(&block)
+      block.call(self) if block_given?
+
+      self
+    end
+
+    def cancel_consumers_before_closing!
+      @cancel_consumers_before_closing = true
+    end
+
+    def cancel_consumers_before_closing?
+      !!@cancel_consumers_before_closing
+    end
+
     # Defines a shutdown event callback. Shutdown events are
     # broadcasted when a channel is closed, either explicitly
     # or forcefully, or due to a network/peer failure.
@@ -482,7 +523,7 @@ module MarchHare
     # @return [MarchHare::Queue] Queue that was declared or looked up in the cache
     # @see http://rubymarchhare.info/articles/queues.html Queues and Consumers guide
     # @see http://rubymarchhare.info/articles/extensions.html RabbitMQ Extensions guide
-    def queue(name, options={})
+    def queue(name, options = {})
       dq = Queue.new(self, name, options).tap do |q|
         q.declare!
       end
@@ -490,6 +531,85 @@ module MarchHare
       self.register_queue(dq)
     end
 
+    # Declares a new client-named quorum queue.
+    #
+    # @param [String] name Queue name. Empty (server-generated) names are not supported by this method.
+    # @param  [Hash]  opts  Queue properties and other options. Durability, exclusivity, auto-deletion options will be ignored.
+    #
+    # @option opts [Hash] :arguments ({}) Optional arguments (x-arguments)
+    #
+    # @return [MarchHare::Queue] Queue that was declared or looked up in the cache
+    # @see #durable_queue
+    # @see #queue
+    # @api public
+    def quorum_queue(name, opts = {})
+      throw ArgumentError.new("quorum queue name must not be nil") if name.nil?
+      throw ArgumentError.new("quorum queue name must not be empty (server-named QQs do not make sense)") if name.empty?
+
+      durable_queue(name, Queue::Types::QUORUM, opts)
+    end
+
+    # Declares a new client-named stream (that Bunny can use as if it was a queue).
+    # Note that Bunny would still use AMQP 0-9-1 to perform operations on this "queue".
+    # To use stream-specific operations and to gain from stream protocol efficiency and partitioning,
+    # use a Ruby client for the RabbitMQ stream protocol.
+    #
+    # @param [String] name Stream name. Empty (server-generated) names are not supported by this method.
+    # @param  [Hash]  opts  Queue properties and other options. Durability, exclusivity, auto-deletion options will be ignored.
+    #
+    # @option opts [Hash] :arguments ({}) Optional arguments (x-arguments)
+    #
+    #
+    # @return [MarchHare::Queue] Queue that was declared or looked up in the cache
+    # @see #durable_queue
+    # @see #queue
+    # @api public
+    def stream(name, opts = {})
+      throw ArgumentError.new("stream name must not be nil") if name.nil?
+      throw ArgumentError.new("stream name must not be empty (server-named QQs do not make sense)") if name.empty?
+
+      durable_queue(name, Queue::Types::STREAM, opts)
+    end
+
+    # Declares a new server-named queue that is automatically deleted when the
+    # connection is closed.
+    #
+    # @param [String] name Queue name. Empty (server-generated) names are not supported by this method.
+    # @param  [Hash]  opts  Queue properties and other options. Durability, exclusivity, auto-deletion options will be ignored.
+    #
+    # @option opts [Hash] :arguments ({}) Optional arguments (x-arguments)
+    #
+    # @return [MarchHare::Queue] Queue that was declared or looked up in the cache
+    # @see #queue
+    # @api public
+    def durable_queue(name, type = Queue::Types::CLASSIC, opts = {})
+      throw ArgumentError.new("queue name must not be nil") if name.nil?
+      throw ArgumentError.new("queue name must not be empty (server-named durable queues do not make sense)") if name.empty?
+
+      final_opts = opts.merge({
+        :type        => type,
+        :durable     => true,
+        # exclusive or auto-delete QQs do not make much sense
+        :exclusive   => false,
+        :auto_delete => false
+      })
+
+      self.queue(name, final_opts)
+    end
+
+    # Declares a new server-named queue that is automatically deleted when the
+    # connection is closed.
+    #
+    # @return [MarchHare::Queue] Queue that was declared or looked up in the cache
+    # @see #queue
+    # @api public
+    def temporary_queue(opts = {})
+      temporary_queue_opts = {
+        :exclusive => true
+      }
+      queue("", opts.merge(temporary_queue_opts))
+    end
+
     # Declares a queue using queue.declare AMQP 0.9.1 method.
     #
     # @param [String] name Queue name
@@ -638,6 +758,13 @@ module MarchHare
       tag
     end
 
+    def basic_cancel(consumer_tag)
+      converting_rjc_exceptions_to_ruby do
+        @delegate.basic_cancel(consumer_tag)
+      end
+      self.unregister_consumer(consumer_tag)
+    end
+
     def basic_qos(prefetch_count)
       r = converting_rjc_exceptions_to_ruby do
         @delegate.basic_qos(prefetch_count)

data/lib/march_hare/queue.rb

@@ -11,6 +11,27 @@ module MarchHare
   # @see http://rubymarchhare.info/articles/queues.html Queues and Consumers guide
   # @see http://rubymarchhare.info/articles/extensions.html RabbitMQ Extensions guide
   class Queue
+    #
+    # API
+    #
+
+    module Types
+      QUORUM  = "quorum"
+      CLASSIC = "classic"
+      STREAM  = "stream"
+
+      KNOWN = [CLASSIC, QUORUM, STREAM]
+
+      def self.known?(q_type)
+        KNOWN.include?(q_type)
+      end
+    end
+
+    module XArgs
+      MAX_LENGTH = "x-max-length",
+      QUEUE_TYPE = "x-queue-type"
+    end
+
     # @return [MarchHare::Channel] Channel this queue uses
     attr_reader :channel
     # @return [String] Queue name
@@ -33,13 +54,20 @@ module MarchHare
 
       @channel = channel
       @name = name
-      @options = {:durable => false, :exclusive => false, :auto_delete => false, :passive => false, :arguments => Hash.new}.merge(options)
+      @options = {:durable => false, :exclusive => false, :auto_delete => false, :passive => false, :arguments => Hash.new, :type => Types::CLASSIC}.merge(options)
 
+      @type         = @options[:type].to_s
       @durable      = @options[:durable]
       @exclusive    = @options[:exclusive]
       @server_named = @name.empty?
       @auto_delete  = @options[:auto_delete]
-      @arguments    = @options[:arguments]
+
+      @arguments        = if @type and !@type.empty? then
+        (@options[:arguments] || {}).merge({XArgs::QUEUE_TYPE => @type})
+      else
+        @options[:arguments]
+      end
+      verify_type!(@arguments)
 
       @bindings     = Set.new
     end
@@ -74,8 +102,6 @@ module MarchHare
       @arguments
     end
 
-
-
     # Binds queue to an exchange
     #
     # @param [MarchHare::Exchange,String] exchange Exchange to bind to
@@ -225,6 +251,18 @@ module MarchHare
     # Implementation
     #
 
+    def self.verify_type!(args0 = {})
+      # be extra defensive
+      args = args0 || {}
+      q_type = args["x-queue-type"] || args[:"x-queue-type"]
+      throw ArgumentError.new(
+        "unsupported queue type #{q_type.inspect}, supported ones: #{Types::KNOWN.join(', ')}") if (q_type and !Types.known?(q_type))
+    end
+
+    def verify_type!(args)
+      self.class.verify_type!(args)
+    end
+
     # @return [Boolean] true if this queue is a pre-defined one (amq.direct, amq.fanout, amq.match and so on)
     def predefined?
       @name.start_with?("amq.")
@@ -232,10 +270,10 @@ module MarchHare
 
     # @private
     def declare!
-      @channel.logger.debug("queue: declare! #{@name}")
+      @channel.logger.debug("queue: declare! #{@name}, type: #{@type}")
       response = if @options[:passive]
                  then @channel.queue_declare_passive(@name)
-                 else @channel.queue_declare(@name, @options[:durable], @options[:exclusive], @options[:auto_delete], @options[:arguments])
+                 else @channel.queue_declare(@name, @durable, @exclusive, @auto_delete, @arguments)
                  end
       @name = response.queue
     end

data/lib/march_hare/session.rb

@@ -57,6 +57,7 @@ module MarchHare
     # @option options [Logger] :logger The logger.  If missing, one is created using :log_file and :log_level.
     # @option options [IO, String] :log_file The file or path to use when creating a logger.  Defaults to STDOUT.
     # @option options [Integer] :log_level The log level to use when creating a logger.  Defaults to LOGGER::WARN
+    # @option options [Integer] :max_inbound_message_body_size Maximum allowed size of an incoming message body. Defaults to 64MiB
     #
     # @see http://rubymarchhare.info/articles/connecting.html Connecting to RabbitMQ guide
     def self.connect(options = {})
@@ -83,6 +84,8 @@ module MarchHare
 
       cf.thread_factory      = thread_factory_from(options)    if include_thread_factory?(options)
 
+      cf.max_inbound_message_body_size = options[:max_inbound_message_body_size].to_i if options[:max_inbound_message_body_size]
+
       tls = (options[:ssl] || options[:tls])
       case tls
       when true then

data/lib/march_hare/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module MarchHare
-  VERSION = "4.6.0"
+  VERSION = "4.7.0"
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: march_hare
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 4.7.0
 platform: java
 authors:
 - Theo Hultberg
 - Michael S. Klishin
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-10 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies: []
 description: RabbitMQ client for JRuby built around the official RabbitMQ Java client
 email:
@@ -41,7 +40,6 @@ files:
 homepage: https://github.com/ruby-amqp/march_hare
 licenses: []
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -56,8 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: RabbitMQ client for JRuby built around the official RabbitMQ Java client
 test_files: []