rmq 0.0.1

data/lib/rmq/exceptions.rb

@@ -0,0 +1,17 @@
+module RMQ
+  class RMQException < RuntimeError
+    include Constants
+
+    attr_reader :reason_code
+    attr_reader :completion_code
+
+    def initialize(completion_code, reason_code)
+      @reason_code = reason_code
+      @completion_code = completion_code
+    end
+
+    def message
+      "#{to_s}. Reason code = #{decode_reason_code(reason_code)} (#{reason_code}), completion code = #{decode_completion_code(completion_code)}"
+    end
+  end
+end

data/lib/rmq/get_message_options.rb

@@ -0,0 +1,55 @@
+module RMQ
+  module MQClient
+
+    class GetMessageOptions < FFI::Struct
+      MQGMO_STRUC_ID        = "GMO "
+      MQGMO_VERSION_1       = 1
+      
+      # Get Message Options
+      MQGMO_WAIT                     = 0x00000001
+      MQGMO_NO_WAIT                  = 0x00000000
+      MQGMO_SET_SIGNAL               = 0x00000008
+      MQGMO_FAIL_IF_QUIESCING        = 0x00002000
+      MQGMO_SYNCPOINT                = 0x00000002
+      MQGMO_SYNCPOINT_IF_PERSISTENT  = 0x00001000
+      MQGMO_NO_SYNCPOINT             = 0x00000004
+      MQGMO_MARK_SKIP_BACKOUT        = 0x00000080
+      MQGMO_BROWSE_FIRST             = 0x00000010
+      MQGMO_BROWSE_NEXT              = 0x00000020
+      MQGMO_BROWSE_MSG_UNDER_CURSOR  = 0x00000800
+      MQGMO_MSG_UNDER_CURSOR         = 0x00000100
+      MQGMO_LOCK                     = 0x00000200
+      MQGMO_UNLOCK                   = 0x00000400
+      MQGMO_ACCEPT_TRUNCATED_MSG     = 0x00000040
+      MQGMO_CONVERT                  = 0x00004000
+      MQGMO_LOGICAL_ORDER            = 0x00008000
+      MQGMO_COMPLETE_MSG             = 0x00010000
+      MQGMO_ALL_MSGS_AVAILABLE       = 0x00020000
+      MQGMO_ALL_SEGMENTS_AVAILABLE   = 0x00040000
+      MQGMO_MARK_BROWSE_HANDLE       = 0x00100000
+      MQGMO_MARK_BROWSE_CO_OP        = 0x00200000
+      MQGMO_UNMARK_BROWSE_CO_OP      = 0x00400000
+      MQGMO_UNMARK_BROWSE_HANDLE     = 0x00800000
+      MQGMO_UNMARKED_BROWSE_MSG      = 0x01000000
+      MQGMO_PROPERTIES_FORCE_MQRFH2  = 0x02000000
+      MQGMO_NO_PROPERTIES            = 0x04000000
+      MQGMO_PROPERTIES_IN_HANDLE     = 0x08000000
+      MQGMO_PROPERTIES_COMPATIBILITY = 0x10000000
+      MQGMO_PROPERTIES_AS_Q_DEF      = 0x00000000
+      MQGMO_NONE                     = 0x00000000
+      
+      layout :StrucId, [:char, 4],
+        :Version, :long,
+        :Options, :long,
+        :WaitInterval, :long,
+        :Signal1, :long,
+        :Signal2, :long,
+        :ResolvedQName, [:char, 48],
+        :MatchOptions, :long,
+        :GroupStatus, :char,
+        :SegmentStatus, :char,
+        :Segmentation, :char,
+        :Reserved1, :char
+    end
+  end
+end

data/lib/rmq/message_descriptor.rb

@@ -0,0 +1,43 @@
+module RMQ
+  module MQClient
+
+    class MessageDescriptor < FFI::Struct
+      MQMD_STRUC_ID         = "MD  "
+      MQMD_VERSION_1        = 1
+      MQEI_UNLIMITED        = -1
+      MQRO_NONE             = 0x00000000
+      MQMT_DATAGRAM         = 8
+      MQPER_PERSISTENT      = 1
+
+      layout  :StrucId, [:char, 4],
+        :Version, :long,
+        :Report, :long,
+        :MsgType, :long,
+        :Expiry, :long,
+        :Feedback, :long,
+        :Encoding, :long,
+        :CodedCharSetId, :long,
+        :Format, [:char, 8],
+        :Priority, :long,
+        :Persistence, :long,
+        :MsgId, [:char, 24],
+        :CorrelId, [:char, 24],
+        :ReplyToQ, [:char, 48],
+        :ReplyToQMgr, [:char, 48],
+        :UserIdentifier, [:char, 12],
+        :AccountingToken, [:char, 32],
+        :ApplIdentityData, [:char, 32],
+        :PutApplType, :long,
+        :PutApplName, [:char, 28],
+        :PutDate, [:char, 8],
+        :PutTime, [:char, 8],
+        :ApplOriginData, [:char, 4],
+        :GroupId, [:char, 24],
+        :MsgSeqNumber, :long,
+        :Offset, :long,
+        :MsgFlags, :long,
+        :OriginalLength, :long
+    end
+
+  end
+end

data/lib/rmq/mqclient.rb

@@ -0,0 +1,282 @@
+module RMQ
+  module MQClient
+    include Constants
+    extend FFI::Library
+
+    ffi_lib "C:\\Program Files (x86)\\IBM\\WebSphere MQ\\bin\\mqic32.dll"
+    ffi_convention :stdcall
+
+    attach_function :mqconn, :MQCONN,
+                    [:string, :pointer, :pointer, :pointer], :void
+    attach_function :mqdisc, :MQDISC,
+                    [:pointer, :pointer, :pointer], :void
+
+    # MQPUT (Hconn, Hobj, &MsgDesc, &PutMsgOpts, BufferLength, &Buffer, &CompCode, &Reason)
+    attach_function :mqput, :MQPUT,
+                    [:long, :long, :pointer, :pointer, :long, :string, :pointer, :pointer], :void
+
+    # MQGET (Hconn, Hobj, &MsgDesc, &GetMsgOpts, BufferLength, Buffer, &DataLength, &CompCode, &Reason)
+    attach_function :mqget, :MQGET,
+                    [:long, :long, :pointer, :pointer, :long, :pointer, :pointer, :pointer, :pointer], :void
+
+    # MQOPEN (Hconn, &ObjDesc, Options, &Hobj, &CompCode, &Reason)
+    attach_function :mqopen, :MQOPEN,
+                    [:long, :pointer, :long, :pointer, :pointer, :pointer], :void
+
+    # MQCLOSE (Hconn, &Hobj, Options, &CompCode, &Reason)
+    attach_function :mqclose, :MQCLOSE,
+                    [:long, :pointer, :long, :pointer, :pointer], :void
+
+    # mqCreateBag (Options, &Bag, &CompCode, &Reason)
+    attach_function :mqai_create_bag, :mqCreateBag,
+                    [:long, :pointer, :pointer, :pointer], :void
+
+    # mqAddString (hBag, Selector, BufferLength, Buffer, &CompCode, &Reason)
+    attach_function :mqai_add_string, :mqAddString,
+                    [:long, :long, :long, :string, :pointer, :pointer], :void
+
+    # mqAddInteger (Bag, Selector, ItemValue, &CompCode, &Reason)
+    attach_function :mqai_add_integer, :mqAddInteger,
+                    [:long, :long, :long, :pointer, :pointer], :void
+
+    # mqInquireString (Bag, Selector, ItemIndex, BufferLength, Buffer, &StringLength, &CodedCharSetId, &CompCode, &Reason)
+    attach_function :mqai_inquire_string, :mqInquireString,
+                    [:long, :long, :long, :long, :pointer, :pointer, :pointer, :pointer, :pointer], :void
+
+    # mqInquireInteger (Bag, Selector, ItemIndex, &ItemValue, &CompCode, &Reason);
+    attach_function :mqai_inquire_integer, :mqInquireInteger,
+                    [:long, :long, :long, :pointer, :pointer, :pointer], :void
+
+    # mqAddInquiry (Bag, Selector, &CompCode, &Reason)
+    attach_function :mqai_add_inquiry, :mqAddInquiry,
+                    [:long, :long, :pointer, :pointer], :void
+
+    # mqExecute (Hconn, Command, OptionsBag, AdminBag, ResponseBag, AdminQ, ResponseQ, CompCode, Reason)
+    attach_function :mqai_execute, :mqExecute,
+                    [:long, :long, :long, :long, :long, :long, :long, :pointer, :pointer], :void
+
+    # mqCountItems (Bag, Selector, &ItemCount, &CompCode, &Reason)
+    attach_function :mqai_count_items, :mqCountItems,
+                    [:long, :long, :pointer, :pointer, :pointer], :void
+
+    # mqInquireBag (Bag, Selector, ItemIndex, &ItemValue, &CompCode, &Reason)
+    attach_function :mqai_inquire_bag, :mqInquireBag,
+                    [:long, :long, :long, :pointer, :pointer, :pointer], :void
+
+    # mqDeleteBag (&Bag, CompCode, Reason)
+    attach_function :mqai_delete_bag, :mqDeleteBag,
+                    [:pointer, :pointer, :pointer], :void
+
+
+    def create_admin_bag
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+
+      adminbag_handle_ptr = FFI::MemoryPointer.new :long
+      mqai_create_bag(MQCBO_ADMIN_BAG, adminbag_handle_ptr, completion_code_ptr, reason_code_ptr)
+      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot create admin bag" if completion_code_ptr.read_long != MQCC_OK
+
+      adminbag_handle_ptr.read_long
+    end
+
+    def create_response_bag
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+
+      responsebag_handle_ptr = FFI::MemoryPointer.new :long
+      mqai_create_bag(MQCBO_ADMIN_BAG, responsebag_handle_ptr, completion_code_ptr, reason_code_ptr)
+      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot create response bag" if completion_code_ptr.read_long != MQCC_OK
+
+      responsebag_handle_ptr.read_long
+    end
+
+    def add_string_to_bag(bag_handle, selector, value)
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+
+      mqai_add_string(bag_handle, selector, MQBL_NULL_TERMINATED, value, completion_code_ptr, reason_code_ptr)
+      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot add string to admin bag" if completion_code_ptr.read_long != MQCC_OK
+    end
+
+    def add_integer_to_bag(bag_handle, selector, value)
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+
+      mqai_add_integer(bag_handle, selector, value, completion_code_ptr, reason_code_ptr)
+      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot add integer to admin bag" if completion_code_ptr.read_long != MQCC_OK
+    end
+
+    def add_inquiry(bag_handle, selector)
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+
+      mqai_add_inquiry(bag_handle, selector, completion_code_ptr, reason_code_ptr)
+      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot add inquiry to admin bag" if completion_code_ptr.read_long != MQCC_OK
+    end
+
+    def execute(connection_handle, command, options_bag, admin_bag, response_bag,
+        admin_queue, response_queue)
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+
+      mqai_execute(connection_handle, command, options_bag, admin_bag,
+        response_bag, admin_queue, response_queue, completion_code_ptr, reason_code_ptr)
+      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot execute admin bag" if completion_code_ptr.read_long != MQCC_OK
+    end
+
+    def count_items(bag_handle, selector)
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+
+      number_of_bags_ptr = FFI::MemoryPointer.new :long
+      mqai_count_items(bag_handle, selector, number_of_bags_ptr, completion_code_ptr, reason_code_ptr)
+      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot count items in response bag" if completion_code_ptr.read_long != MQCC_OK
+
+      number_of_bags_ptr.read_long
+    end
+
+    def inquire_bag(bag_handle, selector, item_index)
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+
+      item_value_ptr = FFI::MemoryPointer.new :long
+      mqai_inquire_bag(bag_handle, selector, item_index, item_value_ptr, completion_code_ptr, reason_code_ptr)
+      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot inquire attributes bag handle from response bag" if completion_code_ptr.read_long != MQCC_OK
+
+      item_value_ptr.read_long
+    end
+
+    def inquire_string(bag_handle, selector, item_index)
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+
+      string_ptr = FFI::MemoryPointer.new :char, 255
+      length_ptr = FFI::MemoryPointer.new :long
+      mqai_inquire_string(bag_handle, selector, item_index, 255, string_ptr, length_ptr, nil, completion_code_ptr, reason_code_ptr)
+      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot inquire string from attributes bag" if completion_code_ptr.read_long != MQCC_OK
+
+      string_ptr.read_string.strip
+    end
+
+    def inquire_integer(bag_handle, selector, item_index)
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+      item_value_ptr = FFI::MemoryPointer.new :long
+
+      mqai_inquire_integer(bag_handle, selector, item_index, item_value_ptr, completion_code_ptr, reason_code_ptr)
+      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot inquire integer from attributes bag" if completion_code_ptr.read_long != MQCC_OK
+
+      item_value_ptr.read_long
+    end
+
+    def delete_bag(bag_handle)
+      unless bag_handle == MQHB_UNUSABLE_HBAG
+        completion_code_ptr = FFI::MemoryPointer.new :long
+        reason_code_ptr = FFI::MemoryPointer.new :long
+        bag_handle_ptr = FFI::MemoryPointer.new :long
+        bag_handle_ptr.write_long(bag_handle)
+
+        mqai_delete_bag(bag_handle_ptr, completion_code_ptr, reason_code_ptr)
+        raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot delete bag" if completion_code_ptr.read_long != MQCC_OK
+      end
+    end
+
+    def open_queue(connection_handle, queue_name, options)
+      object_descriptor = MQClient::ObjectDescriptor.new
+      object_descriptor[:StrucId] = MQClient::ObjectDescriptor::MQOD_STRUC_ID
+      object_descriptor[:Version] = MQClient::ObjectDescriptor::MQOD_VERSION_1
+      object_descriptor[:ObjectType] = MQClient::ObjectDescriptor::MQOT_Q
+      object_descriptor[:ObjectName] = queue_name
+
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+      queue_handle_ptr = FFI::MemoryPointer.new :long
+
+      mqopen(connection_handle, object_descriptor, options, queue_handle_ptr,
+        completion_code_ptr, reason_code_ptr)
+      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot open queue" if completion_code_ptr.read_long != MQCC_OK
+
+      queue_handle_ptr.read_long
+    end
+
+    def close_queue(connection_handle, queue_handle, options)
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+
+      queue_handle_ptr = FFI::MemoryPointer.new :long
+      queue_handle_ptr.write_long(queue_handle)
+
+      mqclose(connection_handle, queue_handle_ptr, options, completion_code_ptr, reason_code_ptr)
+      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot close queue" if completion_code_ptr.read_long != MQCC_OK
+    end
+
+    def put_message_on_queue(connection_handle, queue_handle, payload)
+      message_options = MQClient::PutMessageOptions.new
+      message_options[:StrucId] = MQClient::PutMessageOptions::MQPMO_STRUC_ID
+      message_options[:Version] = MQClient::PutMessageOptions::MQPMO_VERSION_1
+
+      message_descriptor = MQClient::MessageDescriptor.new
+      message_descriptor[:StrucId] = MQClient::MessageDescriptor::MQMD_STRUC_ID
+      message_descriptor[:Version] = MQClient::MessageDescriptor::MQMD_VERSION_1
+      message_descriptor[:Expiry] = MQClient::MessageDescriptor::MQEI_UNLIMITED
+      message_descriptor[:Report] = MQClient::MessageDescriptor::MQRO_NONE
+      message_descriptor[:MsgType] = MQClient::MessageDescriptor::MQMT_DATAGRAM
+      message_descriptor[:Priority] = 1
+      message_descriptor[:Persistence] = MQClient::MessageDescriptor::MQPER_PERSISTENT
+      message_descriptor[:ReplyToQ] = ""
+
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+
+      mqput(connection_handle, queue_handle, message_descriptor, message_options, payload.length, payload, completion_code_ptr, reason_code_ptr)
+      raise RMQException.new(completion_code_ptr.read_long, reason_code_ptr.read_long), "Cannot send message" if completion_code_ptr.read_long != MQCC_OK
+    end
+
+    def queue_depth(connection_handle, queue_name)
+      adminbag_handle = create_admin_bag
+      responsebag_handle = create_response_bag
+
+      add_string_to_bag(adminbag_handle, MQCA_Q_NAME, queue_name)
+      add_integer_to_bag(adminbag_handle, MQIA_Q_TYPE, MQQT_LOCAL)
+      add_inquiry(adminbag_handle, MQIA_CURRENT_Q_DEPTH)
+
+      execute(connection_handle, MQCMD_INQUIRE_Q, MQHB_NONE, adminbag_handle, responsebag_handle, MQHO_NONE, MQHO_NONE)
+
+      attributes_bag_handle = inquire_bag(responsebag_handle, MQHA_BAG_HANDLE, 0)
+      queue_depth = inquire_integer(attributes_bag_handle, MQIA_CURRENT_Q_DEPTH, 0)
+
+      delete_bag(adminbag_handle)
+      delete_bag(responsebag_handle)
+
+      queue_depth
+    end
+
+    def get_message_from_queue(connection_handle, queue_handle)
+      completion_code_ptr = FFI::MemoryPointer.new :long
+      reason_code_ptr = FFI::MemoryPointer.new :long
+      data_length_ptr = FFI::MemoryPointer.new :long
+
+      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_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
+
+      buffer_ptr.read_string
+    end
+
+  end
+end

data/lib/rmq/object_descriptor.rb

@@ -0,0 +1,41 @@
+module RMQ
+  module MQClient
+
+    class ObjectDescriptor < FFI::Struct
+      MQOD_STRUC_ID             = "OD  "
+      MQOD_VERSION_1            = 1
+
+      # Object Types
+      MQOT_NONE       = 0
+      MQOT_Q          = 1
+      MQOT_NAMELIST   = 2
+      MQOT_PROCESS    = 3
+      MQOT_STORAGE_CLASS = 4
+      MQOT_Q_MGR      = 5
+      MQOT_CHANNEL    = 6
+      MQOT_AUTH_INFO  = 7
+      MQOT_TOPIC      = 8
+      MQOT_CF_STRUC   = 10
+      MQOT_LISTENER   = 11
+      MQOT_SERVICE    = 12
+      MQOT_RESERVED_1 = 999
+      
+      
+      layout  :StrucId, [:char, 4],
+        :Version, :long,
+        :ObjectType, :long,
+        :ObjectName, [:char, 48],
+        :ObjectQMgrName, [:char, 48],
+        :DynamicQName, [:char, 48],
+        :AlternateUserId, [:char, 12],
+        :RecsPresent, :long,
+        :KnownDestCount, :long,
+        :UnknownDestCount, :long,
+        :InvalidDestCount, :long,
+        :ObjectRecOffset, :long,
+        :ResponseRecOffset, :long,
+        :ObjectRecPtr, :pointer,
+        :ResponseRecPtr, :pointer
+    end
+  end
+end

data/lib/rmq/put_message_options.rb

@@ -0,0 +1,31 @@
+module RMQ
+  module MQClient
+
+    class PutMessageOptions < FFI::Struct
+      MQPMO_STRUC_ID    = "PMO "
+      MQPMO_VERSION_1   = 1
+      MQPMO_SYNCPOINT   = 0x00000002
+
+      layout  :StrucId, [:char, 4],
+        :Version, :long,
+        :Options, :long,
+        :Timeout, :long,
+        :Context, :long,
+        :KnownDestCount, :long,
+        :UnknownDestCount, :long,
+        :InvalidDestCount, :long,
+        :ResolvedQName, [:char, 48],
+        :ResolvedQMgrName, [:char, 48],
+        :RecsPresent, :long,
+        :PutMsgRecFields, :long,
+        :PutMsgRecOffset, :long,
+        :ResponseRecOffset, :long,
+        :PutMsgRecPtr, :pointer,
+        :ResponseRecPtr, :pointer,
+        :OriginalMsgHandle, :int64,
+        :NewMsgHandle, :int64,
+        :Action, :long,
+        :PubLevel, :long
+    end
+  end
+end