amq-protocol 1.0.0.pre2 → 1.0.0.pre3

data/lib/amq/int_allocator.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+
+require "amq/bit_set"
+
+module AMQ
+  # Simple bitset-based integer allocator, heavily inspired by com.rabbitmq.utility.IntAllocator class
+  # in the RabbitMQ Java client.
+  #
+  # Unlike monotonically incrementing identifier, this allocator is suitable for very long running programs
+  # that aggressively allocate and release channels.
+  class IntAllocator
+
+    #
+    # API
+    #
+
+    # @return [Integer] Number of integers in the allocation range
+    attr_reader :number_of_bits
+    # @return [Integer] Upper boundary of the integer range available for allocation
+    attr_reader :hi
+    # @return [Integer] Lower boundary of the integer range available for allocation
+    attr_reader :lo
+
+    # @param [Integer] lo    Lower boundary of the integer range available for allocation
+    # @param [Integer] hi    Upper boundary of the integer range available for allocation
+    # @raise [ArgumentError] if upper boundary is not greater than the lower one
+    def initialize(lo, hi)
+      raise ArgumentError.new "upper boundary must be greater than the lower one (given: hi = #{hi}, lo = #{lo})" unless hi > lo
+
+      @hi = hi
+      @lo = lo
+
+      @number_of_bits = hi - lo
+      @range          = Range.new(1, @number_of_bits)
+      @free_set       = BitSet.new(@number_of_bits)
+    end # initialize(hi, lo)
+
+    # Attempts to allocate next available integer. If allocation succeeds, allocated value is returned.
+    # Otherwise, nil is returned.
+    #
+    # Current implementation of this method is O(n), where n is number of bits in the range available for
+    # allocation.
+    #
+    # @return [Integer] Allocated integer if allocation succeeded. nil otherwise.
+    def allocate
+      if n = find_unallocated_position
+        @free_set.set(n)
+
+        n
+      else
+        -1
+      end
+    end # allocate
+
+    # Releases previously allocated integer. If integer provided as argument was not previously allocated,
+    # this method has no effect.
+    #
+    # @return [NilClass] nil
+    def free(reservation)
+      @free_set.unset(reservation)
+    end # free(reservation)
+    alias release free
+
+    # @return [Boolean] true if provided argument was previously allocated, false otherwise
+    def allocated?(reservation)
+      @free_set.get(reservation)
+    end # allocated?(reservation)
+
+    # Releases the whole allocation range
+    def reset
+      @free_set.clear
+    end # reset
+
+
+
+    protected
+
+    # This implementation is significantly less efficient
+    # that what the RabbitMQ Java client has (based on java.lang.Long#nextSetBit and
+    # java.lang.Long.numberOfTrailingZeros, and thus binary search over bits).
+    # But for channel id generation, this is a good enough implementation.
+    #
+    # @private
+    def find_unallocated_position
+      r = nil
+      @range.each do |i|
+        if !@free_set.get(i)
+          r = i
+          break;
+        end
+      end
+
+      r
+    end # find_unallocated_position
+  end # IntAllocator
+end # AMQ

data/lib/amq/protocol/version.rb

@@ -1,5 +1,5 @@
 module AMQ
   module Protocol
-    VERSION = "1.0.0.pre2"
+    VERSION = "1.0.0.pre3"
   end # Protocol
 end # AMQ

data/spec/amq/int_allocator_spec.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+
+require 'spec_helper'
+require "amq/int_allocator"
+
+describe AMQ::IntAllocator do
+
+  #
+  # Environment
+  #
+
+  subject do
+    described_class.new(1, 5)
+  end
+
+
+  # ...
+
+
+  #
+  # Examples
+  #
+
+  describe "#number_of_bits" do
+    it "returns number of bits available for allocation" do
+      subject.number_of_bits.should == 4
+    end
+  end
+
+
+  describe "#hi" do
+    it "returns upper bound of the allocation range" do
+      subject.hi.should == 5
+    end
+  end
+
+  describe "#lo" do
+    it "returns lower bound of the allocation range" do
+      subject.lo.should == 1
+    end
+  end
+
+
+  describe "#allocate" do
+    context "when integer in the range is available" do
+      it "returns allocated integer" do
+        subject.allocate.should == 1
+        subject.allocate.should == 2
+        subject.allocate.should == 3
+        subject.allocate.should == 4
+
+        subject.allocate.should == -1
+      end
+    end
+
+    context "when integer in the range IS NOT available" do
+      it "returns -1" do
+        4.times { subject.allocate }
+
+        subject.allocate.should == -1
+        subject.allocate.should == -1
+        subject.allocate.should == -1
+        subject.allocate.should == -1
+      end
+    end
+  end
+
+
+  describe "#free" do
+    context "when the integer WAS allocated" do
+      it "returns frees that integer" do
+        4.times { subject.allocate }
+        subject.allocate.should == -1
+
+        subject.free(1)
+        subject.allocate.should == 1
+        subject.allocate.should == -1
+        subject.free(2)
+        subject.allocate.should == 2
+        subject.allocate.should == -1
+        subject.free(3)
+        subject.allocate.should == 3
+        subject.allocate.should == -1
+      end
+    end
+
+    context "when the integer WAS NOT allocated" do
+      it "has no effect" do
+        32.times { subject.free(1) }
+        subject.allocate.should == 1
+      end
+    end
+  end
+
+
+  describe "#allocated?" do
+    context "when given position WAS allocated" do
+      it "returns true" do
+        3.times { subject.allocate }
+
+        subject.allocated?(1).should be_true
+        subject.allocated?(2).should be_true
+        subject.allocated?(3).should be_true
+      end
+    end
+
+    context "when given position WAS NOT allocated" do
+      it "returns false" do
+        2.times { subject.allocate }
+
+        subject.allocated?(3).should be_false
+        subject.allocated?(4).should be_false
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: amq-protocol
 version: !ruby/object:Gem::Version 
-  hash: -2170921152
+  hash: 4271866905
   prerelease: 6
   segments: 
   - 1
   - 0
   - 0
   - pre
-  - 2
-  version: 1.0.0.pre2
+  - 3
+  version: 1.0.0.pre3
 platform: ruby
 authors: 
 - Jakub Stastny
@@ -51,6 +51,7 @@ files:
 - irb.rb
 - lib/amq/bit_set.rb
 - lib/amq/hacks.rb
+- lib/amq/int_allocator.rb
 - lib/amq/protocol.rb
 - lib/amq/protocol/client.rb
 - lib/amq/protocol/frame.rb
@@ -63,6 +64,7 @@ files:
 - protocol.rb.pytemplate
 - spec/amq/bit_set_spec.rb
 - spec/amq/hacks_spec.rb
+- spec/amq/int_allocator_spec.rb
 - spec/amq/protocol/basic_spec.rb
 - spec/amq/protocol/blank_body_encoding_spec.rb
 - spec/amq/protocol/channel_spec.rb