0mq 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
----
-SHA1:
-  metadata.gz: 473c613f99809b02a04f9dd571c4346fb4a21dc6
-  data.tar.gz: 7715e9eccbb78b63574c49bbb8dde74b399be0b9
-SHA512:
-  metadata.gz: f2634ad6efa95f1fefb126a3d73f846905ea31d3e7796839d35d74146622666b5cbe1e48869dafca39e4cfbf673af839d6a32511ddf8dc056b6241b22a8896fe
-  data.tar.gz: ecc8934f09fcacaaecbc1a4d9a6eb51673495bd1fba521972c0a4b9f0938246d32bba54f91a0ee068f90bd924d7cf4d56c718e7d1e8d9f2d2ab156394f65c076
+--- 
+SHA1: 
+  metadata.gz: 9804002690a57145812c94d81b0ac10f6b034401
+  data.tar.gz: 369e72c53a0e9571f9d8cc105cdb9e61d8329e2c
+SHA512: 
+  metadata.gz: d3ab814c5981fd4aa48fc760b5f2ce40d0c02dc0534853d2400349f9812b06907728d11e47d0167c49d97600d1a44970bf92272547cb490d4f3fcaf3501ed6f4
+  data.tar.gz: 58c50e1b3288430f6188af59f5ef5aa53387db01b0d7a90285f6a4cce45fbe45373736860511b2ca63c66abb4fb8943d3d5d88bbdba1f9e68887b9cb254ea59a

data/lib/0mq.rb

@@ -5,3 +5,4 @@ require_relative '0mq/error_map'
 require_relative '0mq/context'
 require_relative '0mq/socket'
 require_relative '0mq/proxy'
+require_relative '0mq/poll'

data/lib/0mq/context.rb

@@ -11,7 +11,9 @@ module ZMQ
     # Destroy the ØMQ context.
     def terminate
       if @ptr
-        rc = LibZMQ.zmq_ctx_term @ptr
+        rc = LibZMQ.version4?       ? 
+          LibZMQ.zmq_ctx_term(@ptr) : 
+          LibZMQ.zmq_term(@ptr)
         ZMQ.error_check true if rc == -1
         
         @ptr = nil

data/lib/0mq/poll.rb

@@ -0,0 +1,149 @@
+
+module ZMQ
+  
+  # A mechanism for applications to multiplex input/output events
+  # in a level-triggered fashion over a set of sockets.
+  class Poll
+    # Timeout is specified in seconds.
+    # A value of 0 will return immediately (non-blocking), and
+    # a value of -1 will block indefinitely until an event has
+    # occurred. Fractions of a second are allowed.
+    # Timeout defaults to block indefinitely (-1).
+    attr_accessor :timeout
+    
+    # Construct a Poll object and start polling.
+    # See #initialize for parameters.
+    # See #run for block and return value.
+    def self.poll(*sockets, &block)
+      new(*sockets).tap { |poll| poll.run(&block) }
+    end
+    
+    # Non-blocking version of poll.
+    def self.poll_nonblock(*sockets, &block)
+      self.poll *sockets, timeout: 0, &block
+    end
+    
+    # Accepts a list of sockets to poll for events
+    # (ZMQ::POLLIN, ZMQ::POLLOUT, ZMQ::POLLERR).
+    # Default is to poll for input (ZMQ::POLLIN).
+    # To poll for a different kind of event, specify the socket
+    # and event type as a key/value pair
+    # (my_socket => ZMQ::POLLOUT).
+    # Event flags can be binary OR'd together if necessary
+    # (my_socket => ZMQ::POLLIN | ZMQ::POLLOUT).
+    # 
+    # Timeout can be specified in seconds as a keyword arg.
+    # See the :timeout accessor.
+    #
+    # Does not poll until #run is called.
+    #
+    # Example:
+    # ZMQ::Poll.new socket1, socket2, socket3 => ZMQ::POLLOUT, timeout: 1
+    def initialize(*sockets)
+      opts = sockets.last.is_a?(Hash) ? sockets.pop : {} # For Ruby 1.9
+      
+      @timeout = opts.fetch :timeout, -1
+      
+      @poll_items = []
+      @socks = {}
+
+      sockets.each { |socket| @socks[socket] = ZMQ::POLLIN }
+      
+      # Pull remaining sockets out of options hash and package into poll items.
+      # Skip any option symbols in the hash; they aren't sockets.
+      # Rejecting symbols allows duck-typed sockets to be included.
+      @socks.merge! opts.reject {|socket, events| socket.is_a? Symbol}
+      
+      # Build table to reference ZMQ::Socket to its pointer's address.
+      # This is an easy way to reconnect PollItem to ZMQ::Socket without
+      # having to store multiple dimensions in the socks hash.
+      @socket_lookup = {}
+      @socks.each { |socket, event| @socket_lookup[socket.ptr.address] = socket }
+      
+      # Allocate space for C PollItem (zmq_pollitem_t) structs.
+      @poll_structs = FFI::MemoryPointer.new LibZMQ::PollItem, @socks.count, true
+      
+      # Create the PollItem objects.
+      # Initializing them within the FFI::MemoryPointer prevents having to copy
+      # the struct data to the MemoryPointer when polling, then back again to
+      # retrieve the revents flags.
+      i = 0
+      @socks.each do |socket, events|
+        @poll_items.push LibZMQ::PollItem.new(@poll_structs[i]).tap { |pi|
+          pi.socket = socket
+          pi.events = events
+        }
+        
+        i += 1
+      end
+    end
+    
+    # Start polling.
+    # 
+    # Returns a hash of ZMQ::Socket => revents (triggered event flags).
+    # Each item of the hash is passed to the block, if provided.
+    def run(&block)
+      return {} if @poll_items.empty?
+      
+      # Convert seconds to miliseconds.
+      timeout = @timeout > 0 ? (@timeout * 1000).to_i : @timeout
+      
+      # Poll
+      rc = LibZMQ::zmq_poll @poll_structs, @poll_items.count, timeout
+      ZMQ.error_check true if rc==-1
+      
+      # Create a hash of the items with triggered events.
+      # (ZMQ::Socket => revents)
+      triggered_items = @poll_items.select { |pi| pi.revents > 0 }
+        .map { |pi| [@socket_lookup[pi.socket.address], pi.revents] }
+      
+      triggered_items = Hash[triggered_items]
+      
+      # Pass triggered sockets to block.
+      triggered_items.each { |socket, revents| block.call socket, revents } if block
+      
+      triggered_items
+    end
+    
+    # Non-blocking version of run.
+    def run_nonblock(&block)
+      @timeout = 0
+      run &block
+    end
+    
+  end
+end
+
+
+module LibZMQ
+  class PollItem
+    
+    # Get the event flags:
+    # ZMQ::POLLIN, ZMQ::POLLOUT, ZMQ::POLLERR.
+    # Event flags are bitmasked.
+    def events
+      self[:events]
+    end
+    
+    # Set the event flags:
+    # ZMQ::POLLIN, ZMQ::POLLOUT, ZMQ::POLLERR.
+    # Event flags are bitmasked.
+    def events=(flags)
+      self[:events] = flags
+    end
+    
+    # Get requested events that triggered:
+    # ZMQ::POLLIN, ZMQ::POLLOUT, ZMQ::POLLERR.
+    # Event flags are bitmasked.
+    def revents
+      self[:revents]
+    end
+    
+    # Set the socket to poll for events on.
+    # Accepts a ZMQ::Socket or a pointer.
+    def socket=(sock)
+      self[:socket] = sock.is_a?(FFI::Pointer) ? sock : sock.ptr
+    end
+    
+  end
+end

metadata

@@ -1,149 +1,116 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: 0mq
-version: !ruby/object:Gem::Version
-  version: 0.1.2
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
 platform: ruby
-authors:
+authors: 
 - Joe McIlvain
 - Alex McLain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-03-04 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: ffi-rzmq-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id003 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id003
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: pry
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-rescue
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id003
   type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: pry-rescue
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id003
   type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: fivemat
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id003
   type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: fivemat
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id003
+  type: :development
+  version_requirements: *id008
 description: A Ruby-like wrapper for ffi-rzmq-core (ZeroMQ)
 email: joe.eli.mac@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/0mq.rb
 - lib/0mq/context.rb
 - lib/0mq/error_map.rb
+- lib/0mq/poll.rb
 - lib/0mq/proxy.rb
 - lib/0mq/socket.rb
 - lib/0mq/socket/options.rb
 homepage: https://github.com/jemc/0mq/
-licenses:
+licenses: 
 - MIT
 metadata: {}
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: 0mq
 test_files: []
-has_rdoc: 
+