ffi-rzmq 1.0.3 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a406c4de564eef119c3f303a386546d6bfda94fd
+  data.tar.gz: 4ef6371ae1029809d302dc7911d0a5a056328428
+SHA512:
+  metadata.gz: 801813a1a358e60fc0906369c1da88638bdb2c91588da12c50adf2b5869b8542690baa14b3d6098f2ba34e74fcb9468631c5f23ac21dba216782be21a654406d
+  data.tar.gz: 88e1a7bdc0500f6703e94ace2c145f96420fafa89b0bd39927edd5f4a396ca36a4a0bbb543d57b517b115eae5ffb9c55288b1b568fc4ae11f8acee903ceaa1b1

data/.travis.yml

@@ -7,7 +7,7 @@ rvm:
   - ruby-head
   - jruby-19mode
   - jruby-head
-  - rbx-19mode
+  - rbx-2.1.1
 
 matrix:
   allow_failures:

data/AUTHORS.txt

@@ -28,4 +28,8 @@ Simon Chiang , github: thinkerbot
 
 Harlow Ward, github: harlow
 
-Paul Chechetin, github: paulche
+Paul Chechetin, github: paulche
+
+Michael Zaccari, github: mzaccari
+
+Jason Roelofs, github: jasonroelofs

data/History.txt

@@ -1,3 +1,22 @@
+
+== 2.0.0 / 20140108
+	* Split out all of the FFI code to its own gem so other projects can use
+		it without the effort of duplication.
+		
+	*	Support libzmq 4 API and its new security API . Thanks to Devin 
+	  Christensen (devin-c) and Jason Roelofs (jasonroelofs) for related
+	  patches.
+	
+	* Minor documentation fixes. Thanks to Michael Zaccari (mzaccari) for
+	  the fix.
+	
+	* Improved the readability of any FFI code (now moved to ffi-rzmq-core
+	  project). Thanks to Stephen von Takach (stakach) for the patch.
+	
+	* Updated AUTHORS.txt
+	
+
+
 == 1.0.3 / 20131003
 	* Fixes for issues #96 and #97. Thanks to Paul Chechetin (paulche) for 
 	  the issues and patches.

data/README.rdoc

@@ -122,17 +122,15 @@ I highly recommend visiting the Learn Ruby 0mq project for a bunch of good code
 
 == REQUIREMENTS:
 
-  * 0mq 2.2.x, 3.2.x or later; 2.0.x, 3.0.x and 3.1.x are no longer supported
+  * 0mq 3.2.x, 4.x or later; 2.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.
 
 If you have installed ZeroMQ using brew, you need to `brew link zeromq` before installing this gem.
 
-Future releases may include the library as a C extension built at
-time of installation.
-
   * ffi (>= 1.0.0)
+	* ffi-rzmq-core
 
 This is a requirement for MRI and Rubinius. JRuby has FFI support built
 in as a standard component. Do *not* run this gem under MRI with an old 'ffi' gem.

data/examples/README.rdoc

@@ -4,14 +4,12 @@
 
 1. lib dir
 
-All of the examples assume the lib directory containing the gem sources is two directories up from the location of the example.
+All of the examples assume the lib directory containing the gem sources is one directory up from the location of the example.
 
 2. Installed libzmq library
 
 The ZeroMQ C libraries need to be downloaded, compiled and installed separately from the gem. Please see http://www.zeromq.org/area:download for links to the downloadable files along with some simple installation instructions. Also, be sure to check the FAQ if you run into problems with compiling.
 
-This gem auto-configures itself to conform to the API for 0mq 2.1.x and 3.1.x. The 0mq project started making backward-incompatible changes with the 3.x branch. Rather than create separate gems, this one handles all of them.
-
 It is possible to install the libzmq* files directly into the gem in the ext/ directory. This directory is checked for loadable libraries first before it falls back to checking the system paths.
 
 3. One terminal window

data/examples/{v3api/latency_measurement.rb → latency_measurement.rb}

@@ -1,6 +1,5 @@
 
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ffi-rzmq')
-
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
 
 # Within a single process, we start up two threads. One thread has a REQ (request)
 # socket and the second thread has a REP (reply) socket. We measure the

data/examples/{v3api/local_lat.rb → local_lat.rb}

@@ -16,7 +16,7 @@
 #    You should have received a copy of the Lesser GNU General Public License
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ffi-rzmq')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
 
 if ARGV.length < 3
   puts "usage: ruby local_lat.rb <connect-to> <message-size> <roundtrip-count>"

data/examples/{v3api/local_lat_poll.rb → local_lat_poll.rb}

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ffi-rzmq')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
 
 if ARGV.length < 3
   puts "usage: ruby local_lat.rb <connect-to> <message-size> <roundtrip-count>"
@@ -38,7 +38,7 @@ start_time = Time.now
 
 # kick it off
 message = ZMQ::Message.new("a" * message_size)
-assert(s1.sendmsg(message, ZMQ::NonBlocking))
+assert(s1.sendmsg(message, ZMQ::DONTWAIT))
 
 i = roundtrip_count
 
@@ -49,8 +49,8 @@ until i.zero?
 
   poller.readables.each do |socket|
     received_message = ''
-    assert(socket.recv_string(received_message, ZMQ::NonBlocking))
-    assert(socket.sendmsg(ZMQ::Message.new(received_message), ZMQ::NonBlocking))
+    assert(socket.recv_string(received_message, ZMQ::DONTWAIT))
+    assert(socket.sendmsg(ZMQ::Message.new(received_message), ZMQ::DONTWAIT))
   end
 end
 

data/examples/{v3api/local_throughput.rb → local_throughput.rb}

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ffi-rzmq')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
 
 if ARGV.length != 3
   puts "usage: ruby local_throughtput.rb <bind-to> <message-size> <message-count>"

data/examples/{v3api/pub.rb → pub.rb}

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ffi-rzmq')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
 
 if ARGV.length != 3
   puts "usage: ruby remote_throughput.rb <connect-to> <message-size> <message-count>"

data/examples/{v2api/publish_subscribe.rb → publish_subscribe.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ffi-rzmq')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
 
 
 def assert(rc)
@@ -71,7 +71,7 @@ assert(s4.recv_string(body)) if s4.more_parts?
 puts "s4 received topic [#{topic}], body [#{body}]"
 
 s5_string = ''
-rc = s5.recv_string(s5_string, ZMQ::NonBlocking)
+rc = s5.recv_string(s5_string, ZMQ::DONTWAIT)
 eagain = (rc == -1 && ZMQ::Util.errno == ZMQ::EAGAIN)
 puts(eagain ? "s5 received no messages" : "s5 FAILED")
 

data/examples/{v2api/remote_lat.rb → remote_lat.rb}

@@ -17,7 +17,7 @@
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ffi-rzmq')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
 
 if ARGV.length < 3
   puts "usage: ruby remote_lat.rb <connect-to> <message-size> <roundtrip-count>"

data/examples/{v3api/remote_throughput.rb → remote_throughput.rb}

@@ -1,5 +1,5 @@
 
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ffi-rzmq')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
 
 if ARGV.length != 3
   puts "usage: ruby remote_throughput.rb <connect-to> <message-size> <message-count>"
@@ -27,9 +27,10 @@ end
 #assert(s.setsockopt(ZMQ::SNDHWM, 0))
 assert(s.connect(connect_to))
 
-# the sleep gives the downstream SUB socket a chance to register its
+# give the downstream SUB socket a chance to register its
 # subscription filters with this PUB socket
-sleep 1
+puts "Hit any key to start publishing"
+STDIN.gets
 
 contents = "#{'0'*message_size}"
 

data/examples/{v2api/reqrep_poll.rb → reqrep_poll.rb}

@@ -1,6 +1,5 @@
 
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ffi-rzmq')
-
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
 
 def assert(rc)
   raise "Last API call failed at #{caller(1)}" unless rc >= 0
@@ -38,7 +37,7 @@ until @done do
     payload = "#{ '3' * 1024 }"
 
     puts "sending payload nonblocking"
-    assert(s1.send_string(payload, ZMQ::NonBlocking))
+    assert(s1.send_string(payload, ZMQ::DONTWAIT))
     @unsent = false
   end
 
@@ -46,7 +45,7 @@ until @done do
   if Time.now - start_time > 1
     poller.readables.each do |sock|
       received_msg = ''
-      assert(sock.recv_string(received_msg, ZMQ::NonBlocking))
+      assert(sock.recv_string(received_msg, ZMQ::DONTWAIT))
 
       puts "message received [#{received_msg}]"
       @done = true

data/examples/{v2api/request_response.rb → request_response.rb}

@@ -1,6 +1,5 @@
 
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ffi-rzmq')
-
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
 
 def assert(rc)
   raise "Last API call failed at #{caller(1)}" unless rc >= 0

data/examples/{v3api/sub.rb → sub.rb}

@@ -1,11 +1,10 @@
 
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ffi-rzmq')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
 
 #if ARGV.length != 3
 #  puts "usage: ruby local_throughtput.rb <bind-to> <message-size> <message-count>"
 #  Process.exit
 #end
-p ZMQ::Util.version
 
 def assert(rc)
   raise "Last API call failed at #{caller(1)}" unless rc >= 0

data/examples/{v3api/throughput_measurement.rb → throughput_measurement.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ffi-rzmq')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
 require 'thread'
 
 # Within a single process, we start up five threads. Main thread has a PUB (publisher)

data/examples/{v3api/xreqxrep_poll.rb → xreqxrep_poll.rb}

@@ -1,6 +1,5 @@
 
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'ffi-rzmq')
-
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
 
 def assert(rc)
   raise "Last API call failed at #{caller(1)}" unless rc >= 0
@@ -43,7 +42,7 @@ until @done do
 
     5.times do |i|
       payload = "#{ i.to_s * 40 }"
-      assert(s1.send_string(payload, ZMQ::NonBlocking))
+      assert(s1.send_string(payload, ZMQ::DONTWAIT))
     end
     @unsent = false
   end
@@ -54,12 +53,12 @@ until @done do
 
       if sock.identity =~ /xrep/
         routing_info = ''
-        assert(sock.recv_string(routing_info, ZMQ::NonBlocking))
+        assert(sock.recv_string(routing_info, ZMQ::DONTWAIT))
         puts "routing_info received [#{routing_info}] on socket.identity [#{sock.identity}]"
       else
         routing_info = nil
         received_msg = ''
-        assert(sock.recv_string(received_msg, ZMQ::NonBlocking))
+        assert(sock.recv_string(received_msg, ZMQ::DONTWAIT))
 
         # skip to the next iteration if received_msg is nil; that means we got an EAGAIN
         next unless received_msg
@@ -68,13 +67,13 @@ until @done do
 
       while sock.more_parts? do
         received_msg = ''
-        assert(sock.recv_string(received_msg, ZMQ::NonBlocking))
+        assert(sock.recv_string(received_msg, ZMQ::DONTWAIT))
 
         puts "message received [#{received_msg}]"
       end
 
       puts "kick back a reply"
-      assert(sock.send_string(routing_info, ZMQ::SNDMORE | ZMQ::NonBlocking)) if routing_info
+      assert(sock.send_string(routing_info, ZMQ::SNDMORE | ZMQ::DONTWAIT)) if routing_info
       time = Time.now.strftime "%Y-%m-%dT%H:%M:%S.#{Time.now.usec}"
       reply = "reply " + sock.identity.upcase + " #{time}"
       puts "sent reply [#{reply}], #{time}"

data/ffi-rzmq.gemspec

@@ -11,9 +11,9 @@ 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 the major ones -
-MRI, Rubinius and JRuby.}
+and run by any ruby runtime that supports FFI. That's all of the major ones - MRI, Rubinius and JRuby.}
 
+  s.license = 'MIT'
   s.rubyforge_project = "ffi-rzmq"
 
   s.files         = `git ls-files`.split("\n")
@@ -21,7 +21,7 @@ MRI, Rubinius and JRuby.}
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "ffi"#, [">= 1.0.9"]
-  s.add_development_dependency "rspec", ["~> 2.6"]
+  s.add_runtime_dependency "ffi-rzmq-core", [">= 1.0.1"]
+  s.add_development_dependency "rspec", ["~> 2.14"]
   s.add_development_dependency "rake"
 end

data/lib/ffi-rzmq.rb

@@ -63,10 +63,9 @@ end  # module ZMQ
 # some code is conditionalized based upon what ruby engine we are
 # executing
 
-require 'ffi'
+require 'ffi-rzmq-core'
 
 # 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_item poll device).each do |file|
+%w(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/context.rb

@@ -47,44 +47,29 @@ module ZMQ
 
     # Use the factory method Context#create to make contexts.
     #
-    if LibZMQ.version2?
-      def self.create io_threads = 1
-        new(io_threads) rescue nil
-      end
-
-      def initialize io_threads = 1
-        @io_threads = io_threads
-        @context = LibZMQ.zmq_init io_threads
-        ZMQ::Util.error_check 'zmq_init', (@context.nil? || @context.null?) ? -1 : 0
-
-        define_finalizer
-      end
-    elsif LibZMQ.version3?
+    def self.create(opts = {})
+      new(opts) rescue nil
+    end
 
-      def self.create(opts = {})
-        new(opts) rescue nil
+    def initialize(opts = {})
+      if opts.respond_to?(:empty?)
+        @io_threads = opts[:io_threads] || IO_THREADS_DFLT
+        @max_sockets = opts[:max_sockets] || MAX_SOCKETS_DFLT
+      else
+        @io_threads = opts || 1
+        @max_sockets = MAX_SOCKETS_DFLT
       end
 
-      def initialize(opts = {})
-        if opts.respond_to?(:empty?)
-          @io_threads = opts[:io_threads] || IO_THREADS_DFLT
-          @max_sockets = opts[:max_sockets] || MAX_SOCKETS_DFLT
-        else
-          @io_threads = opts || 1
-          @max_sockets = MAX_SOCKETS_DFLT
-        end
-
-        @context = LibZMQ.zmq_ctx_new
-        ZMQ::Util.error_check 'zmq_ctx_new', (@context.nil? || @context.null?) ? -1 : 0
+      @context = LibZMQ.zmq_ctx_new
+      ZMQ::Util.error_check 'zmq_ctx_new', (@context.nil? || @context.null?) ? -1 : 0
 
-        rc = LibZMQ.zmq_ctx_set(@context, ZMQ::IO_THREADS, @io_threads)
-        ZMQ::Util.error_check 'zmq_ctx_set', rc
+      rc = LibZMQ.zmq_ctx_set(@context, ZMQ::IO_THREADS, @io_threads)
+      ZMQ::Util.error_check 'zmq_ctx_set', rc
 
-        rc = LibZMQ.zmq_ctx_set(@context, ZMQ::MAX_SOCKETS, @max_sockets)
-        ZMQ::Util.error_check 'zmq_ctx_set', rc
+      rc = LibZMQ.zmq_ctx_set(@context, ZMQ::MAX_SOCKETS, @max_sockets)
+      ZMQ::Util.error_check 'zmq_ctx_set', rc
 
-        define_finalizer
-      end
+      define_finalizer
     end
 
     # Call to release the context and any remaining data associated
@@ -94,27 +79,14 @@ module ZMQ
     #
     # Returns 0 for success, -1 for failure.
     #
-    if LibZMQ.version2?
-      def terminate
-        unless @context.nil? || @context.null?
-          remove_finalizer
-          rc = LibZMQ.zmq_term @context
-          @context = nil
-          rc
-        else
-          0
-        end
-      end
-    elsif LibZMQ.version3?
-      def terminate
-        unless @context.nil? || @context.null?
-          remove_finalizer
-          rc = LibZMQ.zmq_ctx_destroy(@context)
-          @context = nil
-          rc
-        else
-          0
-        end
+    def terminate
+      unless @context.nil? || @context.null?
+        remove_finalizer
+        rc = LibZMQ.zmq_ctx_destroy(@context)
+        @context = nil
+        rc
+      else
+        0
       end
     end
 

data/lib/ffi-rzmq/device.rb

@@ -3,10 +3,10 @@ module ZMQ
   class Device
     attr_reader :device
 
-    def self.create(device_type, frontend, backend)
+    def self.create(frontend, backend, capture=nil)
       dev = nil
       begin
-        dev = new(device_type, frontend, backend)
+        dev = new(frontend, backend, capture)
       rescue ArgumentError
         dev = nil
       end
@@ -14,15 +14,19 @@ module ZMQ
       dev
     end
 
-    def initialize(device_type, frontend, backend)
+    def initialize(frontend, backend, capture=nil)
       [["frontend", frontend], ["backend", backend]].each do |name, socket|
         unless socket.is_a?(ZMQ::Socket)
           raise ArgumentError, "Expected a ZMQ::Socket, not a #{socket.class} as the #{name}"
         end
       end
 
-      LibZMQ.zmq_device(device_type, frontend.socket, backend.socket)
+      LibZMQ.zmq_proxy(frontend.socket, backend.socket, capture ? capture.socket : nil)
     end
   end
+  
+  # Alias for Device
+  #
+  class Proxy < Device; end
 
 end