rmq 0.0.4 → 0.0.6

data/lib/rmq.rb

@@ -8,5 +8,6 @@ require "rmq/message_descriptor"
 require "rmq/put_message_options"
 require "rmq/get_message_options"
 require "rmq/object_descriptor"
+require "rmq/message"
 require "rmq/queue"
 

data/lib/rmq/constants.rb

@@ -773,6 +773,8 @@ module RMQ
       completion_codes[completion_code]
     end
 
+    MQRC_TRUNCATED_MSG_FAILED = 2080
+
     def decode_reason_code(reason_code)
       reason_codes = {
        0 => :MQRC_NONE,
@@ -781,7 +783,7 @@ module RMQ
        2033 => :MQRC_NO_MSG_AVAILABLE,
        2037 => :MQRC_NOT_OPEN_FOR_INPUT,
        2079 => :MQRC_TRUNCATED_MSG_ACCEPTED,
-       2080 => :MQRC_TRUNCATED_MSG_FAILED,
+       MQRC_TRUNCATED_MSG_FAILED => :MQRC_TRUNCATED_MSG_FAILED,
        2186 => :MQRC_GMO_ERROR,
        2309 => :MQRC_SELECTOR_NOT_PRESENT,
        2320 => :MQRC_HBAG_ERROR,

data/lib/rmq/exceptions.rb

@@ -14,4 +14,8 @@ module RMQ
       "#{to_s}. Reason code = #{decode_reason_code(reason_code)} (#{reason_code}), completion code = #{decode_completion_code(completion_code)}"
     end
   end
+
+  class RMQTimeOutError < RuntimeError
+  end
+
 end

data/lib/rmq/message.rb

@@ -0,0 +1,14 @@
+module RMQ
+  class Message
+    attr_reader :payload
+
+    def initialize(payload, message_descriptor)
+      @payload = payload
+      @message_descriptor = message_descriptor
+    end
+
+    def reply_queue_name
+      @message_descriptor[:ReplyToQ].to_s.strip
+    end
+  end
+end

data/lib/rmq/message_descriptor.rb

@@ -9,6 +9,8 @@ module RMQ
       MQMT_DATAGRAM         = 8
       MQPER_PERSISTENT      = 1
 
+      MSG_ID_LENGTH = 24
+
       layout  :StrucId, [:char, 4],
         :Version, :long,
         :Report, :long,
@@ -20,7 +22,7 @@ module RMQ
         :Format, [:char, 8],
         :Priority, :long,
         :Persistence, :long,
-        :MsgId, [:char, 24],
+        :MsgId, [:char, MSG_ID_LENGTH],
         :CorrelId, [:char, 24],
         :BackoutCount, :long,
         :ReplyToQ, [:char, 48],

data/lib/rmq/mqclient.rb

@@ -251,31 +251,73 @@ module RMQ
       queue_depth
     end
 
-    def get_message_from_queue(connection_handle, queue_handle)
+    def get_message_from_queue(connection_handle, queue_handle, timeout)
+      puts "--- get message from queue"
       completion_code_ptr = FFI::MemoryPointer.new :long
       reason_code_ptr = FFI::MemoryPointer.new :long
       data_length_ptr = FFI::MemoryPointer.new :long
 
+      message_options = prepare_get_message_options(timeout, false)
+      message_descriptor = prepare_get_message_descriptor
+
+      data_length = 8 * 1024
+      buffer_ptr = FFI::MemoryPointer.new :char, data_length
+
+      mqget(connection_handle, queue_handle, message_descriptor, message_options, data_length, buffer_ptr, data_length_ptr, completion_code_ptr, reason_code_ptr)
+
+      if (completion_code_ptr.read_long == MQCC_WARNING && reason_code_ptr.read_long == MQRC_TRUNCATED_MSG_FAILED)
+          msg_id = message_descriptor[:MsgId]
+          data_length = data_length_ptr.read_long
+          buffer_ptr = FFI::MemoryPointer.new :char, data_length
+          message_descriptor = prepare_get_message_descriptor(msg_id)
+          mqget(connection_handle, queue_handle, message_descriptor, message_options, data_length, buffer_ptr, data_length_ptr, completion_code_ptr, reason_code_ptr)
+          raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot read message again after learning message length" if completion_code_ptr.read_long == MQCC_FAILED
+      else
+        raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot learn message length" unless completion_code_ptr.read_long == MQCC_OK
+      end
+
+      Message.new(buffer_ptr.read_string, message_descriptor)
+    end
+
+    private
+
+    def prepare_get_message_options(timeout, accept_truncated_msg)
       message_options = GetMessageOptions.new
       message_options[:StrucId] = GetMessageOptions::MQGMO_STRUC_ID
       message_options[:Version] = GetMessageOptions::MQGMO_VERSION_1
-      message_options[:Options] = GetMessageOptions::MQGMO_ACCEPT_TRUNCATED_MSG
+      message_options[:Options] = 0
+
+      if accept_truncated_msg
+        message_options[:Options] = GetMessageOptions::MQGMO_ACCEPT_TRUNCATED_MSG | message_options[:Options]
+      end
 
+      if timeout > 0
+        message_options[:Options] = GetMessageOptions::MQGMO_WAIT | message_options[:Options]
+        message_options[:WaitInterval] = timeout * 1000
+      end
+
+      message_options
+    end
+
+    def print_msg_id(msg_id)
+      puts "printing msg id"
+      for i in (0..MQClient::MessageDescriptor::MSG_ID_LENGTH-1) do
+        puts "#{i} = #{msg_id[i]}"
+      end
+    end
+
+    def prepare_get_message_descriptor(msg_id = nil)
       message_descriptor = MQClient::MessageDescriptor.new
       message_descriptor[:StrucId] = MQClient::MessageDescriptor::MQMD_STRUC_ID
       message_descriptor[:Version] = MQClient::MessageDescriptor::MQMD_VERSION_1
 
-      # TODO determine message length and then reissue call
-#      mqget(connection_handle, queue_handle, message_descriptor, message_options, 0, nil, data_length_ptr, completion_code_ptr, reason_code_ptr)
-#      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot learn message length" if completion_code_ptr.read_long == MQCC_FAILED
-
-#      data_length = data_length_ptr.read_long
-      data_length = 8192
-      buffer_ptr = FFI::MemoryPointer.new :char, data_length
-      mqget(connection_handle, queue_handle, message_descriptor, message_options, data_length, buffer_ptr, data_length_ptr, completion_code_ptr, reason_code_ptr)
-      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot learn message length" if completion_code_ptr.read_long == MQCC_FAILED
+      if !msg_id.nil?
+        for i in (0..MQClient::MessageDescriptor::MSG_ID_LENGTH-1) do
+          message_descriptor[:MsgId][i] = msg_id[i]
+        end
+      end
 
-      buffer_ptr.read_string
+      message_descriptor
     end
 
   end

data/lib/rmq/queue.rb

@@ -9,6 +9,7 @@ module RMQ
       @queue_name = name
     end
 
+    # Puts a message onto the queue. A reply to queue name can be specified.
     def put_message(payload, reply_queue_name = "")
       @queue_handle = open_queue(@queue_manager.connection_handle, @queue_name, Constants::MQOO_OUTPUT) if @queue_handle.nil?
 
@@ -22,15 +23,33 @@ module RMQ
       queue_depth(@queue_manager.connection_handle, @queue_name)
     end
 
-    def get_message
+    # Gets a message from the queue. A timeout period can be specified in seconds.
+    def get_message(timeout = 0)
       @queue_handle = open_queue(@queue_manager.connection_handle, @queue_name, Constants::MQOO_INPUT_SHARED) if @queue_handle.nil?
 
-      payload = get_message_from_queue(@queue_manager.connection_handle, @queue_handle)
+      if (timeout > 0)
+        begin_time = Time.now.to_i
+        begin
+          message = get_message_from_queue(@queue_manager.connection_handle, @queue_handle, timeout)
+        rescue RMQException
+          end_time = Time.now.to_i
+          raise RMQTimeOutError.new if end_time - begin_time >= timeout
+        end
+      else
+        message = get_message_from_queue(@queue_manager.connection_handle, @queue_handle, 0)
+      end
 
       close_queue(@queue_manager.connection_handle, @queue_handle, Constants::MQCO_NONE)
       @queue_handle = nil
 
-      payload
+      message
+    end
+
+    # Gets a message from the queue and returns the payload only. A timeout period can be specified
+    # in seconds.
+    def get_message_payload(timeout = 0)
+      message = get_message(timeout)
+      message.payload
     end
   end
 end

data/lib/rmq/version.rb

@@ -1,3 +1,3 @@
 module RMQ
-  VERSION = "0.0.4"
+  VERSION = "0.0.6"
 end

data/spec/rmq/queue_manager_spec.rb

@@ -1,8 +1,14 @@
 require 'spec_helper'
 
 describe RMQ::QueueManager do
+  SAMPLE_QUEUE = SpecHelper::DATA[:sample_queue]
 
   after(:each) do
+    begin
+      @qm.delete_queue(SAMPLE_QUEUE) if !@qm.find_queue(SAMPLE_QUEUE).nil?
+    rescue
+      puts "Cannot delete #{SAMPLE_QUEUE}"
+    end
     @qm.disconnect if !@qm.nil?
   end
 
@@ -27,17 +33,17 @@ describe RMQ::QueueManager do
 
   it "should create a new queue" do
     @qm = RMQ::QueueManager::connect(SpecHelper::DATA[:queue_manager])
-    queue = @qm.create_queue("RMQ.SAMPLE")
+    queue = @qm.create_queue(SAMPLE_QUEUE)
     queue.should_not be_nil
 
-    @qm.find_queue("RMQ.SAMPLE").should_not be_nil
+    @qm.find_queue(SAMPLE_QUEUE).should_not be_nil
 
-    @qm.delete_queue("RMQ.SAMPLE")
+    @qm.delete_queue(SAMPLE_QUEUE)
   end
 
   it "should find an existing queue" do
     @qm = RMQ::QueueManager::connect(SpecHelper::DATA[:queue_manager])
-    @qm.find_queue("SYSTEM.ADMIN.COMMAND.QUEUE").should_not be_nil    # SAMPLE_IN needs to be changed to one that always exists
+    @qm.find_queue("SYSTEM.ADMIN.COMMAND.QUEUE").should_not be_nil
   end
 
   it "should not find a non-existing queue" do
@@ -47,11 +53,11 @@ describe RMQ::QueueManager do
 
   it "should delete a queue" do
     @qm = RMQ::QueueManager::connect(SpecHelper::DATA[:queue_manager])
-    @qm.create_queue("RMQ.SAMPLE")
-    @qm.find_queue("RMQ.SAMPLE").should_not be_nil
+    @qm.create_queue(SAMPLE_QUEUE)
+    @qm.find_queue(SAMPLE_QUEUE).should_not be_nil
 
-    @qm.delete_queue("RMQ.SAMPLE")
-    @qm.find_queue("RMQ.SAMPLE").should be_nil
+    @qm.delete_queue(SAMPLE_QUEUE)
+    @qm.find_queue(SAMPLE_QUEUE).should be_nil
   end
 
 end

data/spec/rmq/queue_spec.rb

@@ -1,16 +1,21 @@
 require 'spec_helper'
 
 describe RMQ::Queue do
+  SAMPLE_QUEUE = SpecHelper::DATA[:sample_queue]
 
   before(:each) do
     @qm = RMQ::QueueManager::connect(SpecHelper::DATA[:queue_manager])
 
-    @qm.delete_queue("RMQ.SAMPLE") unless @qm.find_queue("RMQ.SAMPLE").nil?
-    @queue = @qm.create_queue("RMQ.SAMPLE")
+    @qm.delete_queue(SAMPLE_QUEUE) unless @qm.find_queue(SAMPLE_QUEUE).nil?
+    @queue = @qm.create_queue(SAMPLE_QUEUE)
   end
 
   after(:each) do
-    @qm.delete_queue("RMQ.SAMPLE")
+    begin
+      @qm.delete_queue(SAMPLE_QUEUE)
+    rescue
+      puts "Cannot delete #{SAMPLE_QUEUE}"
+    end
     @qm.disconnect if !@qm.nil?
   end
 
@@ -21,11 +26,22 @@ describe RMQ::Queue do
 
   it "should read a message from a queue" do
     @queue.put_message("I want to read this back")
-    @queue.get_message.should == "I want to read this back"
+    @queue.get_message_payload.should == "I want to read this back"
   end
 
   it "should put a message on a queue and use a reply queue name" do
+    @queue.put_message("I want to read this back", "REPLY_QUEUE")
+    message = @queue.get_message
+    message.should_not be_nil
+    message.reply_queue_name.should == "REPLY_QUEUE"
+  end
+
+  it "should time out waiting for a message" do
+    lambda { @queue.get_message(2) }.should raise_error(RMQ::RMQTimeOutError)
+  end
 
+  it "should time out waiting for a message and not return any payload" do
+    lambda { @queue.get_message_payload(2) }.should raise_error(RMQ::RMQTimeOutError)
   end
 
 end

data/spec/spec_helper.rb

@@ -5,7 +5,8 @@ MQSERVER = "SYSTEM.DEF.SVRCONN/TCP/127.0.0.1(1414)"
 
 module SpecHelper
   DATA = {
-      :queue_manager => "BKR_QMGR"
+      :queue_manager => "BKR_QMGR",
+      :sample_queue => "RMQ.SAMPLE"
   }
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rmq
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &21388056 !ruby/object:Gem::Requirement
+  requirement: &22131996 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *21388056
+  version_requirements: *22131996
 - !ruby/object:Gem::Dependency
   name: ffi
-  requirement: &21387768 !ruby/object:Gem::Requirement
+  requirement: &22131528 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *21387768
+  version_requirements: *22131528
 description: Ruby wrapper around MQ series client library
 email: sns@caimito.net
 executables: []
@@ -42,6 +42,7 @@ files:
 - lib/rmq/constants.rb
 - lib/rmq/exceptions.rb
 - lib/rmq/get_message_options.rb
+- lib/rmq/message.rb
 - lib/rmq/message_descriptor.rb
 - lib/rmq/mqclient.rb
 - lib/rmq/object_descriptor.rb