0mq 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b804860f9ff37973173ff9061a18674bfebfdc1d
-  data.tar.gz: fb5c958be97696bed9da3faa6c04bc7362377234
+  metadata.gz: 136e40f0d38d2aa86916cc8134140819f3b6153d
+  data.tar.gz: b9dc4d0d931e3069dcd6f72705d23276e5b96fd5
 SHA512:
-  metadata.gz: 16dbace3339b1acf206c4f9cdcb33bedb8a92291748feec4c6a437b55a3595245aa6ba12502f8e39ddf4416ffd543288a4e164ad47ed56960e2e48da117acd1c
-  data.tar.gz: 31357bb71a7f4f43525f328ee87a195472d6d4f1d22f1391f44b456043cb4e3841353f7922b5a7d75e8a22fe0e6c7e19ea59932a482b8f0596ac9449095c212e
+  metadata.gz: 6e78f5d97aac700192c295c5c246e310154c1a259d7f9e478552bcadf62daec60aee60994c8bba0cd8430fd872a7cd6f8de9bd73f577d7058fe0557b67198069
+  data.tar.gz: fedd23a1ff754f4e94da1388990633dea10b1b87b48951189093d3b801e5d4d24dfd6ce051c7330a10d1e77f4b536099fc87048ff3b01a4d3fe1cbf3ba3ef3d0

data/lib/0mq.rb

@@ -1,6 +1,6 @@
 require 'ffi-rzmq-core'
 
-require_relative '0mq/error_map'
+require_relative '0mq/error_check'
 
 require_relative '0mq/context'
 require_relative '0mq/socket'

data/lib/0mq/context.rb

@@ -9,21 +9,70 @@ module ZMQ
     attr_reader :pointer
     
     def initialize
+      # FFI socket pointer for this context
       @pointer = LibZMQ.zmq_ctx_new
+      
+      # List of FFI socket pointers associated with this context.
+      # Each Socket is responsible for registering and unregistering
+      # its pointer from the Context it is associated with.
+      # See #register_socket_pointer and #unregister_socket_pointer,
+      # as well as #terminate and self.finalizer (where they get closed)
+      @socket_pointers = Array.new
+      @socket_pointers_mutex = Mutex.new
+      
+      ObjectSpace.define_finalizer self,
+        self.class.finalizer(@pointer, @socket_pointers, Process.pid)
+    end
+    
+    # @api private
+    def register_socket_pointer pointer
+      @socket_pointers_mutex.synchronize do
+        @socket_pointers.push pointer
+      end
+    end
+    
+    # @api private
+    def unregister_socket_pointer pointer
+      @socket_pointers_mutex.synchronize do
+        @socket_pointers.delete pointer
+      end
     end
     
     # Destroy the ØMQ context.
     def terminate
       if @pointer
-        rc = LibZMQ.version4?       ? 
-          LibZMQ.zmq_ctx_term(@pointer) : 
-          LibZMQ.zmq_term(@pointer)
-        ZMQ.error_check true if rc == -1
+        ObjectSpace.undefine_finalizer self
+        
+        rc = LibZMQ.respond_to?(:zmq_ctx_term) ? 
+          LibZMQ.zmq_ctx_term(pointer)   : 
+          LibZMQ.zmq_term(pointer)
+        ZMQ.error_check true if rc==-1
         
         @pointer = nil
       end
     end
     
+    # Create a safe finalizer for the context pointer to terminate on GC
+    def self.finalizer(pointer, socket_pointers, pid)
+      Proc.new do
+        if Process.pid == pid
+          # Close all socket pointers associated with this context.
+          #
+          # If any of these sockets are still open when zmq_ctx_term is called,
+          # the call will hang.  This is problematic, as the execution of
+          # finalizers is not multithreaded, and the order of finalizers is not
+          # guaranteed.  Even when the Sockets each hold a reference to the
+          # Context, the Context could still be GCed first, causing lockup.
+          socket_pointers.each { |ptr| LibZMQ.zmq_close ptr }
+          socket_pointers.clear
+          
+          LibZMQ.respond_to?(:zmq_ctx_term) ? 
+            LibZMQ.zmq_ctx_term(pointer)    : 
+            LibZMQ.zmq_term(pointer)
+        end
+      end
+    end
+    
     # Create a Socket within this context.
     def socket(type, opts={})
       opts[:context] = self

data/lib/0mq/{error_map.rb → error_check.rb}

@@ -3,12 +3,12 @@ module ZMQ
   
   # A hash of error number => exception class.
   # Example: 1 => Errno::EPERM
-  ErrorMap = Hash.new
+  @error_map = Hash.new
   
   Errno.constants
     .map    { |x| Errno.const_get x }
     .select { |x| x.is_a?(Class) && x < SystemCallError }
-    .each   { |x| ErrorMap[x.const_get(:Errno)] = x }
+    .each   { |x| @error_map[x.const_get(:Errno)] = x }
   
   
   # Checks the libzmq global error number and raises it as an exception.
@@ -16,11 +16,14 @@ module ZMQ
   # Example: ZMQ.error_check if rc == -1
   def self.error_check(adjust_backtrace=false)
     errno = LibZMQ.zmq_errno
-    return true if errno == 25
+    return true if errno == 25 # TODO: What is this for? Remove?
     
-    # TODO: Use adjust_backtrace
-    str = ''
-    raise ErrorMap[errno], str, caller[0...-2]
+    backtrace = adjust_backtrace ? caller[0...-2] : caller
+    if @error_map.has_key? errno
+      raise @error_map[errno], '', backtrace
+    else
+      raise SystemCallError, errno.to_s, backtrace
+    end
   end
   
 end

data/lib/0mq/poll_interruptible.rb

@@ -106,7 +106,5 @@ module ZMQ
       @dead
     end
     
-    # TODO: add finalizer for cleanup for neglectful user developers
-    
   end
 end

data/lib/0mq/socket.rb

@@ -23,8 +23,10 @@ module ZMQ
       
       @msgptr = FFI::MemoryPointer.new LibZMQ::Message.size, 1, false
       
+      @context.send :register_socket_pointer, @pointer
+      
       ObjectSpace.define_finalizer self,
-                                   self.class.finalizer(@socket, Process.pid)
+        self.class.finalizer(@pointer, @context, Process.pid)
     end
     
     # Show a useful inspect output
@@ -37,13 +39,16 @@ module ZMQ
       @closed = true
       
       if @pointer
-        ObjectSpace.undefine_finalizer self
         @temp_buffers.clear if @temp_buffers
         
+        ObjectSpace.undefine_finalizer self
+        @context.send :unregister_socket_pointer, @pointer
+        
         rc = LibZMQ.zmq_close @pointer
         ZMQ.error_check true if rc==-1
         
         @pointer = nil
+        @context = nil
       end
     end
     
@@ -52,9 +57,14 @@ module ZMQ
       @closed
     end
     
-    # Create a safe finalizer for the socket pointer to close on GC of the object
-    def self.finalizer(pointer, pid)
-      Proc.new { LibZMQ.zmq_close pointer if Process.pid == pid }
+    # Create a safe finalizer for the socket pointer to close on GC
+    def self.finalizer(pointer, context, pid)
+      Proc.new do
+        if Process.pid == pid
+          context.send :unregister_socket_pointer, pointer
+          LibZMQ.zmq_close pointer
+        end
+      end
     end
     
     # Get the socket type name as a symbol

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 0mq
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Joe McIlvain
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-08 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-rzmq-core
@@ -134,7 +134,7 @@ files:
 - lib/0mq.rb
 - lib/0mq/context.rb
 - lib/0mq/curve.rb
-- lib/0mq/error_map.rb
+- lib/0mq/error_check.rb
 - lib/0mq/poll.rb
 - lib/0mq/poll_interruptible.rb
 - lib/0mq/proxy.rb