ffi-rzmq 0.9.0 → 0.9.2

data/lib/ffi-rzmq/poll.rb

@@ -85,7 +85,7 @@ module ZMQ
           item[:fd] = fd
         end
 
-        @raw_to_socket[item[:socket].address] = sock
+        @raw_to_socket[item.socket.address] = sock
         @items << item
       end
 
@@ -143,7 +143,7 @@ module ZMQ
       removed_readable = deregister_readable sock
       removed_writable = deregister_writable sock
 
-      if (size = @sockets.size) > 0
+      unless (removed_readable || removed_writable) || (size = @sockets.size).zero?
         @sockets.delete_if { |socket| socket.socket.address == sock.socket.address }
         socket_deleted = size != @sockets.size
 
@@ -172,7 +172,7 @@ module ZMQ
 
     def items_hash hash
       @items.each do |poll_item|
-        hash[@raw_to_socket[poll_item[:socket].address]] = poll_item
+        hash[@raw_to_socket[poll_item.socket.address]] = poll_item
       end
     end
 
@@ -181,8 +181,14 @@ module ZMQ
       @writables.clear
 
       @items.each do |poll_item|
-        @readables << @raw_to_socket[poll_item[:socket].address] if poll_item.readable?
-        @writables << @raw_to_socket[poll_item[:socket].address] if poll_item.writable?
+        #FIXME: spec for sockets *and* file descriptors
+        if poll_item.readable?
+          @readables << (poll_item.socket.address.zero? ? poll_item.fd : @raw_to_socket[poll_item.socket.address])
+        end
+        
+        if poll_item.writable?
+          @writables << (poll_item.socket.address.zero? ? poll_item.fd : @raw_to_socket[poll_item.socket.address])
+        end
       end
     end
 
@@ -194,11 +200,22 @@ module ZMQ
     # Users will pass in values measured as
     # milliseconds, so we need to convert that value to
     # microseconds for the library.
-    def adjust timeout
-      if :blocking == timeout || -1 == timeout
-        -1
-      else
-        (timeout * 1000).to_i
+    if LibZMQ.version2?
+      def adjust timeout
+        if :blocking == timeout || -1 == timeout
+          -1
+        else
+          (timeout * 1000).to_i
+        end
+      end
+    else
+      # version3 changed units from microseconds to milliseconds
+      def adjust timeout
+        if :blocking == timeout || -1 == timeout
+          -1
+        else
+          timeout.to_i
+        end
       end
     end
   end

data/lib/ffi-rzmq/socket.rb

@@ -34,7 +34,7 @@ module ZMQ
     def self.create context_ptr, type, opts = {:receiver_class => ZMQ::Message}
       new(context_ptr, type, opts) rescue nil
     end
-    
+
     # To avoid rescuing exceptions, use the factory method #create for
     # all socket creation.
     #
@@ -68,7 +68,7 @@ module ZMQ
       # users may override the classes used for receiving; class must conform to the
       # same public API as ZMQ::Message
       @receiver_klass = opts[:receiver_class]
-      
+
       context_ptr = context_ptr.pointer if context_ptr.kind_of?(ZMQ::Context)
 
       unless context_ptr.null?
@@ -100,14 +100,13 @@ module ZMQ
     #  ZMQ::RECONNECT_IVL
     #  ZMQ::BACKLOG
     #  ZMQ::RECOVER_IVL_MSEC (version 2 only)
-    #  ZMQ::RECONNECT_IVL_MAX (version 3/4 only)
-    #  ZMQ::MAXMSGSIZE (version 3/4 only)
-    #  ZMQ::SNDHWM (version 3/4 only)
-    #  ZMQ::RCVHWM (version 3/4 only)
-    #  ZMQ::MULTICAST_HOPS (version 3/4 only)
-    #  ZMQ::RCVTIMEO (version 3/4 only)
-    #  ZMQ::SNDTIMEO (version 3/4 only)
-    #  ZMQ::RCVLABEL (version 3/4 only)
+    #  ZMQ::RECONNECT_IVL_MAX (version 3 only)
+    #  ZMQ::MAXMSGSIZE (version 3 only)
+    #  ZMQ::SNDHWM (version 3 only)
+    #  ZMQ::RCVHWM (version 3 only)
+    #  ZMQ::MULTICAST_HOPS (version 3 only)
+    #  ZMQ::RCVTIMEO (version 3 only)
+    #  ZMQ::SNDTIMEO (version 3 only)
     #
     # Valid +name+ values that take a string +value+ are:
     #  ZMQ::IDENTITY (version 2/3 only)
@@ -169,7 +168,7 @@ module ZMQ
     def more_parts?
       array = []
       rc = getsockopt ZMQ::RCVMORE, array
-      
+
       Util.resultcode_ok?(rc) ? array.at(0) : false
     end
 
@@ -197,7 +196,7 @@ module ZMQ
     #
     #  rc = socket.close
     #  puts("Given socket was invalid!") unless 0 == rc
-    # 
+    #
     def close
       if @socket
         remove_finalizer
@@ -244,7 +243,7 @@ module ZMQ
           length.write_int 8
           @sockopt_cache[:int64] = [FFI::MemoryPointer.new(:int64), length]
         end
-        
+
         @sockopt_cache[:int64]
 
       elsif int_option?(name)
@@ -254,7 +253,7 @@ module ZMQ
           length.write_int 4
           @sockopt_cache[:int32] = [FFI::MemoryPointer.new(:int32), length]
         end
-        
+
         @sockopt_cache[:int32]
 
       elsif string_option?(name)
@@ -262,7 +261,7 @@ module ZMQ
         # could be a string of up to 255 bytes
         length.write_int 255
         [FFI::MemoryPointer.new(255), length]
-        
+
       else
         # uh oh, someone passed in an unknown option; use a slop buffer
         unless @sockopt_cache[:unknown]
@@ -270,7 +269,7 @@ module ZMQ
           length.write_int 4
           @sockopt_cache[:unknown] = [FFI::MemoryPointer.new(:int32), length]
         end
-        
+
         @sockopt_cache[:unknown]
       end
     end
@@ -386,12 +385,12 @@ module ZMQ
       #
       def getsockopt name, array
         rc = __getsockopt__ name, array
-        
+
         if Util.resultcode_ok?(rc) && (RCVMORE == name || MCAST_LOOP == name)
           # convert to boolean
           array[0] = 1 == array[0]
         end
-          
+
         rc
       end
 
@@ -564,14 +563,14 @@ module ZMQ
       def recv_strings list, flag = 0
         array = []
         rc = recvmsgs array, flag
-        
+
         if Util.resultcode_ok?(rc)
           array.each do |message|
             list << message.copy_out_string
             message.close
           end
         end
-        
+
         rc
       end
 
@@ -594,26 +593,60 @@ module ZMQ
       def recvmsgs list, flag = 0
         flag = NOBLOCK if noblock?(flag)
 
-        parts = []
         message = @receiver_klass.new
         rc = recv message, flag
-        parts << message
-
-        # check rc *first*; necessary because the call to #more_parts? can reset
-        # the zmq_errno to a weird value, so the zmq_errno that was set on the
-        # call to #recv gets lost
-        while Util.resultcode_ok?(rc) && more_parts?
-          message = @receiver_klass.new
-          rc = recv message, flag
-          parts << message
+
+        if Util.resultcode_ok?(rc)
+          list << message
+
+          # check rc *first*; necessary because the call to #more_parts? can reset
+          # the zmq_errno to a weird value, so the zmq_errno that was set on the
+          # call to #recv gets lost
+          while Util.resultcode_ok?(rc) && more_parts?
+            message = @receiver_klass.new
+            rc = recv message, flag
+
+            if Util.resultcode_ok?(rc)
+              list << message
+            else
+              message.close
+              list.each { |msg| msg.close }
+              list.clear
+            end
+          end
+        else
+          message.close
         end
 
-        # only append the received parts if there were no errors
-        # FIXME:
-        # need to detect EAGAIN if flag is set; EAGAIN means we have read all that we
-        # can and should return whatever was already read; need a spec!
+        rc
+      end
+
+      # Should only be used for XREQ, XREP, DEALER and ROUTER type sockets. Takes
+      # a +list+ for receiving the message body parts and a +routing_envelope+
+      # for receiving the message parts comprising the 0mq routing information.
+      #
+      # Returns 0 when all messages were successfully dequeued.
+      # Returns -1 under two conditions.
+      # 1. A message could not be dequeued
+      # 2. When +flags+ is set with ZMQ::NOBLOCK and the socket returned EAGAIN.
+      #
+      # With a -1 return code, the user must check ZMQ.errno to determine the
+      # cause. Also, the +list+ *may* be modified when there was an error.
+      #
+      def recv_multipart list, routing_envelope, flag = 0
+        parts = []
+        rc = recvmsgs parts, flag
+
         if Util.resultcode_ok?(rc)
-          parts.each { |part| list << part }
+          routing = true
+          parts.each do |part|
+            if routing
+              routing_envelope << part
+              routing = part.size > 0
+            else
+              list << part
+            end
+          end
         end
 
         rc
@@ -662,7 +695,7 @@ module ZMQ
   end # LibZMQ.version2?
 
 
-  if LibZMQ.version3? || LibZMQ.version4?
+  if LibZMQ.version3?
     class Socket
       include CommonSocketBehavior
       include IdentitySupport
@@ -704,41 +737,13 @@ module ZMQ
       #
       def getsockopt name, array
         rc = __getsockopt__ name, array
-        
+
         if Util.resultcode_ok?(rc) && (RCVMORE == name)
           # convert to boolean
           array[0] = 1 == array[0]
         end
-          
-        rc
-      end
 
-      # The last message part received is tested to see if it is a label.
-      #
-      # Equivalent to calling Socket#getsockopt with ZMQ::RCVLABEL.
-      #
-      # Warning: if the call to #getsockopt fails, this method will return
-      # false and swallow the error.
-      #
-      #  labels = []
-      #  message_parts = []
-      #  message = Message.new
-      #  rc = socket.recv(message)
-      #  if ZMQ::Util.resultcode_ok?(rc)
-      #    label? ? labels.push(message) : message_parts.push(message)
-      #    while more_parts?
-      #      message = Message.new
-      #      if ZMQ::Util.resulcode_ok?(socket.recv(message))
-      #        label? ? labels.push(message) : message_parts.push(message)
-      #      end
-      #    end
-      #  end
-      #
-      def label?
-        array = []
-        rc = getsockopt ZMQ::RCVLABEL, array
-        
-        Util.resultcode_ok?(rc) ? array.at(0) : false
+        rc
       end
 
       # Queues the message for transmission. Message is assumed to conform to the
@@ -796,7 +801,7 @@ module ZMQ
       def send_strings parts, flags = 0
         return -1 if !parts || parts.empty?
         flags = DONTWAIT if dontwait?(flags)
-        
+
         parts[0..-2].each do |part|
           rc = send_string part, (flags | ZMQ::SNDMORE)
           return rc unless Util.resultcode_ok?(rc)
@@ -822,7 +827,7 @@ module ZMQ
       def sendmsgs parts, flags = 0
         return -1 if !parts || parts.empty?
         flags = DONTWAIT if dontwait?(flags)
-        
+
         parts[0..-2].each do |part|
           rc = sendmsg part, (flags | ZMQ::SNDMORE)
           return rc unless Util.resultcode_ok?(rc)
@@ -901,14 +906,14 @@ module ZMQ
       def recv_strings list, flag = 0
         array = []
         rc = recvmsgs array, flag
-        
+
         if Util.resultcode_ok?(rc)
           array.each do |message|
             list << message.copy_out_string
             message.close
           end
         end
-        
+
         rc
       end
 
@@ -918,28 +923,55 @@ module ZMQ
       # +flag+ may be ZMQ::DONTWAIT. Any other flag will be
       # removed.
       #
-      # Raises the same exceptions as Socket#recv.
-      #
       def recvmsgs list, flag = 0
         flag = DONTWAIT if dontwait?(flag)
 
-        parts = []
         message = @receiver_klass.new
         rc = recvmsg message, flag
-        parts << message
-
-        # check rc *first*; necessary because the call to #more_parts? can reset
-        # the zmq_errno to a weird value, so the zmq_errno that was set on the
-        # call to #recv gets lost
-        while Util.resultcode_ok?(rc) && more_parts?
-          message = @receiver_klass.new
-          rc = recvmsg message, flag
-          parts << message
+
+        if Util.resultcode_ok?(rc)
+          list << message
+
+          # check rc *first*; necessary because the call to #more_parts? can reset
+          # the zmq_errno to a weird value, so the zmq_errno that was set on the
+          # call to #recv gets lost
+          while Util.resultcode_ok?(rc) && more_parts?
+            message = @receiver_klass.new
+            rc = recvmsg message, flag
+            
+            if Util.resultcode_ok?(rc)
+              list << message
+            else
+              message.close
+              list.each { |msg| msg.close }
+              list.clear
+            end
+          end
+        else
+          message.close
         end
 
-        # only append the received parts if there were no errors
+        rc
+      end
+
+      # Should only be used for XREQ, XREP, DEALER and ROUTER type sockets. Takes
+      # a +list+ for receiving the message body parts and a +routing_envelope+
+      # for receiving the message parts comprising the 0mq routing information.
+      #
+      def recv_multipart list, routing_envelope, flag = 0
+        parts = []
+        rc = recvmsgs parts, flag
+
         if Util.resultcode_ok?(rc)
-          parts.each { |part| list << part }
+          routing = true
+          parts.each do |part|
+            if routing
+              routing_envelope << part
+              routing = part.size > 0
+            else
+              list << part
+            end
+          end
         end
 
         rc
@@ -955,7 +987,6 @@ module ZMQ
 
       def int_option? name
         super ||
-        RCVLABEL          == name ||
         RECONNECT_IVL_MAX == name ||
         RCVHWM            == name ||
         SNDHWM            == name ||

data/lib/ffi-rzmq/util.rb

@@ -42,6 +42,22 @@ module ZMQ
       [major.read_int, minor.read_int, patch.read_int]
     end
 
+    # Attempts to bind to a random tcp port on +host+ up to +max_tries+
+    # times. Returns the port number upon success or nil upon failure.
+    #
+    def self.bind_to_random_tcp_port host = '127.0.0.1', max_tries = 500
+      tries = 0
+      rc = -1
+
+      while !resultcode_ok?(rc) && tries < max_tries
+        tries += 1
+        random = random_port
+        rc = socket.bind "tcp://#{host}:#{random}"
+      end
+
+      resultcode_ok?(rc) ? random : nil
+    end
+
     # Returns the proper flag value for non-blocking regardless of 0mq
     # version.
     #
@@ -51,7 +67,7 @@ module ZMQ
         NOBLOCK
       end
 
-    elsif LibZMQ.version3? || LibZMQ.version4?
+    elsif LibZMQ.version3?
       
       def self.nonblocking_flag
         DONTWAIT
@@ -62,6 +78,11 @@ module ZMQ
 
     private
 
+    # generate a random port between 10_000 and 65534
+    def self.random_port
+      rand(55534) + 10_000
+    end
+
     # :doc:
     # Called by most library methods to verify there were no errors during
     # operation. If any are found, raise the appropriate #ZeroMQError.