0mq 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 620201ac4bf75176a5ab224bd0bf0f0c3598e028
-  data.tar.gz: c360991d9cf9aa84873672945bd84252cb191263
+  metadata.gz: ed94fa721edb7ba1b1406ec9c7601528e7f425c2
+  data.tar.gz: b982fa07e6efe22051a8a9789857dce377deaf5f
 SHA512:
-  metadata.gz: 32f96897d84651bcc51e2e9037401ceb4839963a2523b534cbd9a46ffa6c4bad2f58a7c35e641505bc8a8b924a6153f5342bdd57c73a3cd9dc99f2e94f2572a2
-  data.tar.gz: 448432e63a64c0fe205e277c0040cb41fa13e90772b57c9f0b03c7eae8e100f16ae0afe011dd301df7c7f3d34e126e3647b03d2efda86a215ac7fdba736ec034
+  metadata.gz: 3e02444d6b525dba0d7acaa03afae14f89ba49e956dc1e4d110190abed9c2c1739a06ca895a4ca605a9b174d3c444ffa6bf572bf617aa13887d5b44a8b78701e
+  data.tar.gz: dec5b627b739c246c233d70a05574c3e32bdd678054fb3885ccbe63f906ff1a7b6e65a040d256141b8d6f04e573c382044f608d85a77b31c372a750360034cbd

data/lib/0mq.rb

@@ -6,6 +6,7 @@ require_relative '0mq/context'
 require_relative '0mq/socket'
 require_relative '0mq/proxy'
 require_relative '0mq/poll'
+require_relative '0mq/poll_interruptible'
 require_relative '0mq/curve'
 require_relative '0mq/version'
 

data/lib/0mq/poll_interruptible.rb

@@ -0,0 +1,89 @@
+
+module ZMQ
+  
+  # An interruptible version of Poll.
+  class PollInterruptible < Poll
+    
+    # Creates the additional interruption objects and calls super
+    # Note that either #kill or #close MUST be called when done with the object.
+    # There is no automatic finalizer for this object.
+    def initialize(*sockets)
+      @int_context = ZMQ::Context.new
+      @int_sock_rep = ZMQ::Socket.new ZMQ::REP, context:@int_context
+      @int_sock_req = ZMQ::Socket.new ZMQ::REQ, context:@int_context
+      @int_sock_rep.bind    "inproc://int"
+      @int_sock_req.connect "inproc://int"
+      
+      @dead = false
+      
+      super @int_sock_rep, *sockets
+    end
+    
+    # Same as Poll#run, but will yield [nil, nil] to the block if interrupted
+    def run(&block)
+      raise "#{self} cannot run; it was permanently killed." if @dead
+      
+      super do |socket, revents|
+        if socket == @int_sock_rep
+          result = socket.recv_array
+          
+          block.call nil, nil if block
+          
+          socket.send_array ["OKAY"]
+          @int_sock_rep.close if result == ["KILL"]
+        else
+          block.call socket, revents if block
+        end
+      end.tap { |hash| hash.delete @int_sock_rep }
+    end
+    
+    # Interrupt the running poll loop, but do not clean up.
+    # This should be run anytime to let the poller re-evaluate state, etc..
+    # This should only be accessed from a thread other than the poll thread,
+    #   and only if the poll thread is running
+    def interrupt
+      @int_sock_req.send_string ""
+      @int_sock_req.recv_array
+      
+      true
+    end
+    
+    # Interrupt the running poll loop and permanently kill the Poll object
+    # This should be run once, when the Poll object is no longer needed.
+    # This should only be accessed from a thread other than the poll thread,
+    #   and only if the poll thread is running
+    # Use #cleanup instead when there is no poll loop thread running.
+    def kill
+      return nil if @dead
+      
+      @int_sock_req.send_array ["KILL"]
+      @int_sock_req.recv_array
+      @int_sock_req.close
+      @int_context.terminate
+      
+      @dead = true
+    end
+    
+    # Permanently kill the Poll object
+    # This should be run once, when the Poll object is no longer needed.
+    # This should only be accessed when there is no poll thread running.
+    # Use #kill instead when there is a poll loop thread running.
+    def close
+      return nil if @dead
+      
+      @int_sock_rep.close
+      @int_sock_req.close
+      @int_context.terminate
+      
+      @dead = true
+    end
+    
+    # Return true if the object has been killed or closed and cannot be run
+    def dead?
+      @dead
+    end
+    
+    # TODO: add finalizer for cleanup for neglectful user developers
+    
+  end
+end

data/lib/0mq/socket.rb

@@ -15,6 +15,7 @@ module ZMQ
     attr_reader :type
     
     def initialize(type, opts={})
+      @closed = false
       @context = opts.fetch :context, ZMQ::DefaultContext
       @type = type
       @pointer = LibZMQ.zmq_socket @context.pointer, @type
@@ -26,8 +27,15 @@ module ZMQ
                                    self.class.finalizer(@socket, Process.pid)
     end
     
+    # Show a useful inspect output
+    def inspect
+      "#<#{self.class}:#{type_sym}:#{object_id.to_s(16)}>"
+    end
+    
     # Close the socket
     def close
+      @closed = true
+      
       if @pointer
         ObjectSpace.undefine_finalizer self
         @temp_buffers.clear if @temp_buffers
@@ -39,6 +47,11 @@ module ZMQ
       end
     end
     
+    # Returns true if the socket is closed.
+    def closed?
+      @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 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 0mq
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Joe McIlvain
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi-rzmq-core
@@ -122,6 +122,7 @@ files:
 - lib/0mq/curve.rb
 - lib/0mq/error_map.rb
 - lib/0mq/poll.rb
+- lib/0mq/poll_interruptible.rb
 - lib/0mq/proxy.rb
 - lib/0mq/socket.rb
 - lib/0mq/socket/options.rb