ffi-rzmq 0.9.6 → 0.9.7

data/.travis.yml

@@ -0,0 +1,16 @@
+script: bundle exec rspec
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ruby-head
+  - jruby-18mode
+  - jruby-19mode
+  - jruby-head
+  - rbx-18mode
+  - rbx-19mode
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/AUTHORS.txt

@@ -17,3 +17,9 @@ Stefan Kaes, github: skaes
 Dmitry Ustalov, github: eveel
 
 Patrik Sundberg, github: sundbp
+
+Pawel Pacana, github: pawelpacana
+
+Brian Ford, github: brixen
+
+Nilson Santos F. Jr., github: nilsonfsj

data/Gemfile

@@ -1,3 +1,5 @@
 source "http://rubygems.org"
 
 gemspec
+
+gem "jruby-openssl", :platform => :jruby

data/History.txt

@@ -1,3 +1,37 @@
+== 0.9.7 / 20121221
+  * BROKE THE API.
+    ZMQ::Poller#register and ZMQ::Poller#deregister don't take fd argument
+    anymore. ZMQ::Poller#readables and ZMQ::Poller#writables return pollables
+    instead of just fd when pollable is other than ZMQ socket.
+    ZMQ::Poller#register now returns nil instead of false when no pollable
+    or events to register to are given, which is consistent with rest of api.
+		Thanks to Pawel Pacana for this code contribution.
+
+  * Added support in ZMQ::Poller for pollables responding to fileno and socket.
+    Standard Ruby Sockets and IOs can be now registered in poller to listen for
+    events. Thanks to Pawel Pacana for this code contribution.
+
+  * Fixed a bug in ZMQ::Poller#deregister where it would raise exception
+    when trying to deregister already closed ZMQ socket. Issue 59.
+
+  * Improved specs to use random inproc socket address to avoid race conditions 
+    between tests under same context.
+
+  * Added continous integration for all supported platforms on Travis-CI.
+		Thanks to Pawel Pacana for this code contribution.
+
+	*	Signed up for codeclimate.com and made some code changes to get a better
+		"grade" from it.
+		
+	*	Modified the library to *always* load the 'ffi' library upon startup. It 
+		used to be conditional for Rubinius. Thanks to brixen for the change.
+		
+	*	There was a little bit of churn on the zmq "monitor" api. Thanks to
+		Nilson Santos F. Jr. for some code to conditionally attach to the
+		appropriate api depending on library version.
+		
+	
+
 == 0.9.6 / 20120808
   * Never released 0.9.5 as a gem. It was available via github only.
   

data/README.rdoc

@@ -13,56 +13,18 @@ This single gem supports 0mq 2.x and 3.1.x 0mq APIs. The 0mq project started
 making backward-incompatible changes to the API with the 3.1.x release.
 The gem auto-configures itself to expose the API conforming to the loaded
 C library. 0mq API 3.0 is *not* supported; the 0mq community voted to
-abandon it. 
+abandon it.
 
 The impetus behind this library was to provide support for ZeroMQ in
 JRuby which has native threads. Unlike MRI, which has a GIL, JRuby and
-Rubinius allow for threaded access to Ruby code from outside extensions. 
-ZeroMQ is heavily threaded, so until the MRI runtime removes its GIL, 
+Rubinius allow for threaded access to Ruby code from outside extensions.
+ZeroMQ is heavily threaded, so until the MRI runtime removes its GIL,
 JRuby and Rubinius will likely be the best environments to run this library.
 
-== Breaking API Changes from 0.8.x to 0.9.0
+Please read the History.txt file for a description of all changes, including
+API changes, since the last release!
 
-There has been a major change in API from the 0.8.x series to 0.9.0. 
-Previously the Socket#send and Socket#recv methods could raise exceptions
-when there was an error. They also returned true or false depending on
-the success or failure of the operation. The exceptions were also used
-for managing flow control when doing non-blocking send/recv.
-
-Mixing and matching return codes and exceptions is a terrible idea in 
-practice. Using them for flow control is an even worse sin. So all of 
-the exception code from Socket has been removed.
-
-The Poller and Message class have also had their exceptions removed for
-returning errors on instance methods.
-
-Unfortunately, it isn't possible to indicate that a call to #new has failed
-by returning nil. A call to #new that fails needs to raise an exception to
-indicate failure. (This isn't strictly true; this behavior can be changed
-but it is not a standard Ruby idiom and is therefore a surprising, and
-poor, thing to do.) Classes that formerly raised exceptions during allocation
-now offer a factory method #create that will either return a successfully
-constructed object or nil. Code should check for nil returns before using
-the object.
-
-This is a *breaking* change. I'm sorry but the old API's inconsistency was
-causing too many problems. It now more closely mimics the 0mq C API. IF YOU
-PREFER THE ORIGINAL API WHICH WAS CLOSER TO IDIOMATIC RUBY, IT SHOULD BE
-EASY TO WRAP THESE CLASSES UP TO PROVIDE A MORE IDIOMATIC API. I SUGGEST
-YOU CREATE A PATCH *OR* CREATE A SEPARATE GEM TO WRAP THIS ONE. Sorry for
-shouting but I wanted to make sure this stood out.
-
-All example code has been updated to use the new Ruby API.
-
-== Breaking API Change from 0.9.3 to 0.9.5
-
-The 0mq library functions zmq_send() and zmq_recv() were changed to 
-zmq_sendmsg() and zmq_recvmsg() with the 0mq 3.x API change. I have changed
-the binding to always use #sendmsg and #recvmsg. This breaks existing code.
-This should be the last breaking change heading into the 1.0 release of these
-bindings.
-
-== PERFORMANCE
+== PERFORMANCE:
 
 Check out the latest performance results:
 
@@ -72,7 +34,7 @@ Check out the latest performance results:
 
 This gem needs more tests. This gem has been battle tested by myself
 and others for over a year, so I am fairly confident that it is solid.
-However, it is inevitable that there will be bugs, so please open 
+However, it is inevitable that there will be bugs, so please open
 issues for them here or fork this project, fix them, and send me a pull
 request.
 
@@ -83,76 +45,82 @@ stability.
 
 All features are implemented.
 
+== BUILD STATUS:
+
+{<img src="https://secure.travis-ci.org/chuckremes/ffi-rzmq.png?branch=master" alt="Build Status" />}[http://travis-ci.org/chuckremes/ffi-rzmq]
+
+{<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/chuckremes/ffi-rzmq]
+
 == SYNOPSIS:
 
 0mq API v2 client code:
-  
+
   require 'rubygems'
   require 'ffi-rzmq'
-  
+
   if ARGV.length < 3
     puts "usage: local_lat <connect-to> <message-size> <roundtrip-count>"
     exit
   end
-  
+
   bind_to = ARGV[0]
   message_size = ARGV[1].to_i
   roundtrip_count = ARGV[2].to_i
-  
+
   ctx = ZMQ::Context.new
   s = ctx.socket ZMQ::REP
   rc = s.setsockopt(ZMQ::HWM, 100)
   rc = s.bind(bind_to)
-  
+
   msg = ""
   roundtrip_count.times do
     rc = s.recv_string msg
     raise "Message size doesn't match, expected [#{message_size}] but received [#{msg.size}]" if message_size != msg.size
     rc = s.send_string msg, 0
   end
-  
+
 
 0mq API v2 server code:
 
   require 'rubygems'
   require 'ffi-rzmq'
-  
+
   if ARGV.length < 3
     puts "usage: remote_lat <connect-to> <message-size> <roundtrip-count>"
     exit
   end
-  
+
   connect_to = ARGV[0]
   message_size = ARGV[1].to_i
   roundtrip_count = ARGV[2].to_i
-  
+
   ctx = ZMQ::Context.new
   s = ctx.socket ZMQ::REQ
   rc = s.connect(connect_to)
-  
+
   msg = "#{ '3' * message_size }"
-  
+
   start_time = Time.now
-  
+
   msg = ""
   roundtrip_count.times do
     rc = s.send_string msg, 0
     rc = s.recv_string msg
     raise "Message size doesn't match, expected [#{message_size}] but received [#{msg.size}]" if message_size != msg.size
   end
-  
+
 == Better Examples
 
 I highly recommend visiting the Learn Ruby 0mq project for a bunch of good code examples.
 
   http://github.com/andrewvc/learn-ruby-zeromq
-  
+
 
 
 == REQUIREMENTS:
 
-  * 0mq 2.1.x, 3.1.x or later; 2.0.x and 3.0.x are no longer supported
-  
+  * 0mq 2.2.x, 3.2.x or later; 2.0.x, 3.0.x and 3.1.x are no longer supported
+
 The ZeroMQ library must be installed on your system in a well-known location
 like /usr/local/lib. This is the default for new ZeroMQ installs.
 
@@ -162,7 +130,7 @@ Future releases may include the library as a C extension built at
 time of installation.
 
   * ffi (>= 1.0.0)
-  
+
 This is a requirement for MRI only. Both Rubinius and JRuby have FFI support built
 in as a standard component. Do *not* run this gem under MRI with an old 'ffi' gem.
 It will crash randomly and you will be sad.
@@ -182,18 +150,18 @@ To build from git master:
  % cd ffi-rzmq
  % gem build ffi-rzmq.gemspec
  % gem install ffi-rzmq-*.gem
- 
+
 
 NOTE for Windows users!
 In order for this gem to find the libzmq.dll, it *must* be on the Windows PATH. Google
 for "modify windows path" for instructions on how to do that if you are unfamiliar with
-that activity.
+that activity. That DLL also requires that you copy libstdc++-6.dll and libgcc_s_sjlj-1.dll from DevKit MinGW into the same folder that you copied libzmq.dll.
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2011 Chuck Remes
+Copyright (c) 2013 Chuck Remes
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/ffi-rzmq.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |s|
   s.summary     = %q{This gem wraps the ZeroMQ (0mq) networking library using Ruby FFI (foreign function interface).}
   s.description = %q{This gem wraps the ZeroMQ networking library using the ruby FFI (foreign
 function interface). It's a pure ruby wrapper so this gem can be loaded
-and run by any ruby runtime that supports FFI. That's all of them -
-MRI 1.9.x, Rubinius and JRuby.}
+and run by any ruby runtime that supports FFI. That's all of the major ones -
+MRI, Rubinius and JRuby.}
 
   s.rubyforge_project = "ffi-rzmq"
 

data/lib/ffi-rzmq.rb

@@ -1,4 +1,3 @@
-
 module ZMQ
 
   # :stopdoc:
@@ -64,12 +63,10 @@ end  # module ZMQ
 # some code is conditionalized based upon what ruby engine we are
 # executing
 
-RBX = defined?(RUBY_ENGINE) && RUBY_ENGINE =~ /rbx/ ? true : false
-
-require 'ffi' unless RBX
+require 'ffi'
 
 # the order of files is important
 #%w(wrapper zmq exceptions context message socket poll_items poll device).each do |file|
-%w(libc libzmq constants util exceptions context message socket poll_items poll device).each do |file|
+%w(libc libzmq constants util exceptions context message socket poll_items poll_item poll device).each do |file|
   require ZMQ.libpath(['ffi-rzmq', file])
 end

data/lib/ffi-rzmq/libzmq.rb

@@ -215,10 +215,17 @@ module ZMQ
       attach_function :zmq_msg_get, [:pointer, :int], :int
       @blocking = true
       attach_function :zmq_msg_set, [:pointer, :int, :int], :int
-      
+
       # Monitoring API
-      @blocking = true
-      attach_function :zmq_ctx_set_monitor, [:pointer, :pointer], :int
+      # zmq_ctx_set_monitor is no longer supported as of version >= 3.2.1
+      # replaced by zmq_socket_monitor
+      if LibZMQ.version[:minor] > 2 || (LibZMQ.version[:minor] == 2 && LibZMQ.version[:patch] >= 1)
+        @blocking = true
+        attach_function :zmq_socket_monitor, [:pointer, :pointer, :int], :int
+      else
+        @blocking = true
+        attach_function :zmq_ctx_set_monitor, [:pointer, :pointer], :int
+      end
 
       # Socket API
       @blocking = true
@@ -233,7 +240,7 @@ module ZMQ
       attach_function :zmq_sendmsg, [:pointer, :pointer, :int], :int
       @blocking = true
       attach_function :zmq_send, [:pointer, :pointer, :size_t, :int], :int
-      
+
       module EventDataLayout
         def self.included(base)
           base.class_eval do
@@ -259,7 +266,7 @@ module ZMQ
 
         def to_s; inspect; end
       end # class EventData
-      
+
     end
   end
 

data/lib/ffi-rzmq/poll.rb

@@ -1,14 +1,14 @@
+require 'forwardable'
 
 module ZMQ
-
   class Poller
+    extend Forwardable
 
+    def_delegators :@poll_items, :size, :inspect
     attr_reader :readables, :writables
 
     def initialize
-      @items = ZMQ::PollItems.new
-      @raw_to_socket = {}
-      @sockets = []
+      @poll_items = ZMQ::PollItems.new
       @readables = []
       @writables = []
     end
@@ -28,8 +28,8 @@ module ZMQ
     # frequency.
     #
     # Returns 0 when there are no registered sockets that are readable
-    # or writable. 
-    # 
+    # or writable.
+    #
     # Return 1 (or greater) to indicate the number of readable or writable
     # sockets. These sockets should be processed using the #readables and
     # #writables accessors.
@@ -38,14 +38,11 @@ module ZMQ
     # error number.
     #
     def poll timeout = :blocking
-      unless @items.empty?
+      unless @poll_items.empty?
         timeout = adjust timeout
-        items_triggered = LibZMQ.zmq_poll @items.address, @items.size, timeout
-        
-        if Util.resultcode_ok?(items_triggered)
-          update_selectables
-        end
-        
+        items_triggered = LibZMQ.zmq_poll @poll_items.address, @poll_items.size, timeout
+
+        update_selectables if Util.resultcode_ok?(items_triggered)
         items_triggered
       else
         0
@@ -62,131 +59,85 @@ module ZMQ
       poll 0
     end
 
-    # Register the +sock+ for +events+. This method is idempotent meaning
+    # Register the +pollable+ for +events+. This method is idempotent meaning
     # it can be called multiple times with the same data and the socket
     # will only get registered at most once. Calling multiple times with
     # different values for +events+ will OR the event information together.
     #
-    def register sock, events = ZMQ::POLLIN | ZMQ::POLLOUT, fd = 0
-      return false if (sock.nil? && fd.zero?) || events.zero?
+    def register pollable, events = ZMQ::POLLIN | ZMQ::POLLOUT
+      return if pollable.nil? || events.zero?
 
-      item = @items.get(@sockets.index(sock))
-
-      unless item
-        @sockets << sock
-        item = LibZMQ::PollItem.new
-
-        if sock.kind_of?(ZMQ::Socket) || sock.kind_of?(Socket)
-          item[:socket] = sock.socket
-          item[:fd] = 0
-        else
-          item[:socket] = FFI::MemoryPointer.new(0)
-          item[:fd] = fd
-        end
-
-        @raw_to_socket[item.socket.address] = sock
-        @items << item
+      unless item = @poll_items[pollable]
+        item = PollItem.from_pollable(pollable)
+        @poll_items << item
       end
 
-      item[:events] |= events
+      item.events |= events
     end
 
-    # Deregister the +sock+ for +events+. When there are no events left,
-    # this also deletes the socket from the poll items.
+    # Deregister the +pollable+ for +events+. When there are no events left
+    # or socket has been closed this also deletes the socket from the poll items.
     #
-    def deregister sock, events, fd = 0
-      return unless sock || !fd.zero?
-
-      item = @items.get(@sockets.index(sock))
+    def deregister pollable, events
+      return unless pollable
 
-      if item && (item[:events] & events) > 0
-        # change the value in place
-        item[:events] ^= events
-
-        delete sock if item[:events].zero?
+      item = @poll_items[pollable]
+      if item && (item.events & events) > 0
+        item.events ^= events
+        delete(pollable) if item.events.zero? || item.closed?
         true
       else
         false
       end
     end
 
-    # A helper method to register a +sock+ as readable events only.
+    # A helper method to register a +pollable+ as readable events only.
     #
-    def register_readable sock
-      register sock, ZMQ::POLLIN, 0
+    def register_readable pollable
+      register pollable, ZMQ::POLLIN
     end
 
-    # A helper method to register a +sock+ for writable events only.
+    # A helper method to register a +pollable+ for writable events only.
     #
-    def register_writable sock
-      register sock, ZMQ::POLLOUT, 0
+    def register_writable pollable
+      register pollable, ZMQ::POLLOUT
     end
 
-    # A helper method to deregister a +sock+ for readable events.
+    # A helper method to deregister a +pollable+ for readable events.
     #
-    def deregister_readable sock
-      deregister sock, ZMQ::POLLIN, 0
+    def deregister_readable pollable
+      deregister pollable, ZMQ::POLLIN
     end
 
-    # A helper method to deregister a +sock+ for writable events.
+    # A helper method to deregister a +pollable+ for writable events.
     #
-    def deregister_writable sock
-      deregister sock, ZMQ::POLLOUT, 0
+    def deregister_writable pollable
+      deregister pollable, ZMQ::POLLOUT
     end
 
-    # Deletes the +sock+ for all subscribed events. Called internally
+    # Deletes the +pollable+ for all subscribed events. Called internally
     # when a socket has been deregistered and has no more events
     # registered anywhere.
     #
     # Can also be called directly to remove the socket from the polling
     # array.
     #
-    def delete sock
-      unless (size = @sockets.size).zero?
-        @sockets.delete_if { |socket| socket.socket.address == sock.socket.address }
-        socket_deleted = size != @sockets.size
-
-        item_deleted = @items.delete sock
-
-        raw_deleted = @raw_to_socket.delete(sock.socket.address)
-
-        socket_deleted && item_deleted && raw_deleted
-        
-      else
-        false
-      end
+    def delete pollable
+      return false if @poll_items.empty?
+      @poll_items.delete(pollable)
     end
 
-    def size(); @items.size; end
-
-    def inspect
-      @items.inspect
-    end
-
-    def to_s(); inspect; end
-
+    def to_s inspect; end
 
     private
 
-    def items_hash hash
-      @items.each do |poll_item|
-        hash[@raw_to_socket[poll_item.socket.address]] = poll_item
-      end
-    end
-
     def update_selectables
       @readables.clear
       @writables.clear
 
-      @items.each do |poll_item|
-        #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
+      @poll_items.each do |poll_item|
+        @readables << poll_item.pollable if poll_item.readable?
+        @writables << poll_item.pollable if poll_item.writable?
       end
     end
 
@@ -198,6 +149,7 @@ module ZMQ
     # Users will pass in values measured as
     # milliseconds, so we need to convert that value to
     # microseconds for the library.
+    #
     if LibZMQ.version2?
       def adjust timeout
         if :blocking == timeout || -1 == timeout
@@ -216,6 +168,6 @@ module ZMQ
         end
       end
     end
-  end
 
-end # module ZMQ
+  end
+end