ffi-rzmq 1.0.3 → 2.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 691dd239d1036375a2f06806953e89e7674d6c19
+  data.tar.gz: 74f1929b8be63e5d38b884e24a6bacab02fe90e9
+SHA512:
+  metadata.gz: e78fb2755c2325b4de8fe3922d8c14b45a1171488ab26897c868f72e7b233b755ba1eb44bdacbd6ee4023d4228f9e57718bf86a0cf1cf427d3fb04b480d8876d
+  data.tar.gz: 3bc7c5bfb8d9212959a41fb8e7a00d3f73873fe5e8d68abded9f20aa182d4b6cd4d74a7d6d7e14030e5d66e5ef191cf22f1614cdffc217cc523df1cc17f91a66

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,48 @@
+== 2.0.4
+  * Screwed up the release managment. Had wrong version in version.rb. Fixed.
+  
+== 2.0.3
+  * Updated specs to use RSpec 3.x syntax. Never again... if they change it
+    then I'm dumping rspec.
+    
+  * Now loading version.rb during startup so that ZMQ::VERSION returns a string.
+  
+  * Modified README to point most people to the Ruby gem that wraps the CZMQ
+    library. It's a much higher-level library that makes writing zeromq apps
+    very easy. This gem is for writing low-level code which most people don't
+    want or need to do. This gem is going into maintenance mode only.
+  
+
+== 2.0.2 
+
+  * Updated README to make it clearer which versions of libzmq are supported.
+  
+  * Updated README to use a newer example.
+
+== 2.0.1 / 20140122
+  * Fix setsockopt with string parameters for options that have very strict
+    requirements (like CURVE_SECRETKEY) (37aed3c)
+
+  * Provide a wrapper for zmq_curve_keypair for ZeroMQ4
+
+== 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

@@ -2,6 +2,22 @@ ffi-rzmq
     by Chuck Remes
     http://www.zeromq.org/bindings:ruby-ffi
 
+== FUTURE SUPPORT
+
+Most people writing Zeromq applications in Ruby should be using the rbczmq
+project. It wraps the CZMQ binding which is a much higher-level library
+for writing Zeromq code. Find the Ruby gem here:
+
+    http://github.com/methodmissing/rbczmq
+    
+Few projects need to write the low-level zeromq code that this gem allows.
+With the release of ffi-rzmq 2.0.3, this library is going into permanent 
+maintenance mode. As new versions of libzmq are released, interested parties
+should send pull requests to this project or its related project
+ffi-rzmq-core to support new features.
+
+The original README text follows...
+
 == DESCRIPTION:
 
 This gem wraps the ZeroMQ networking library using the ruby FFI (foreign
@@ -9,11 +25,18 @@ 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.
 
-This single gem supports 0mq 2.2.x and 3.2.x 0mq APIs. The 0mq project started
+The Ruby API provided by this gem is *NOT* very Ruby-like. It very closely
+tracks the libzmq C API. However, the contributors to this project have
+done all of the hard work to wrap up all of libzmq and make it accessible
+from Ruby. If you want it to be more Ruby-like (e.g. raise Exceptions instead
+of returning integer codes) then *wrap this library* with your own and release
+it as a gem. We will all be grateful!
+
+This single gem supports 0mq 3.2.x and 4.x 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.
+C library. 0mq 2.x is no longer supported. 0mq API 3.0 is *not* supported; 
+the 0mq community voted to 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
@@ -36,7 +59,7 @@ than using a C extension.
 == FEATURES/PROBLEMS:
 
 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.
+and others for years, so I am fairly confident that it is solid.
 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.
@@ -56,62 +79,71 @@ All features are implemented.
 
 == SYNOPSIS:
 
-0mq API v2 client code:
+0mq API v3.2-4 client code:
 
   require 'rubygems'
   require 'ffi-rzmq'
 
   if ARGV.length < 3
-    puts "usage: local_lat <connect-to> <message-size> <roundtrip-count>"
+    puts "usage: ruby local_lat.rb <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)
+  s   = ctx.socket ZMQ::REP
+  rc  = s.setsockopt(ZMQ::SNDHWM, 100)
+  rc  = s.setsockopt(ZMQ::RCVHWM, 100)
+  rc  = s.bind(bind_to)
 
-  msg = ""
   roundtrip_count.times do
-    rc = s.recv_string msg
+    msg = ""
+    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
+    rc  = s.send_string msg, 0
   end
 
-
-0mq API v2 server code:
+0mq API v3.2-4 server code:
 
   require 'rubygems'
   require 'ffi-rzmq'
 
   if ARGV.length < 3
-    puts "usage: remote_lat <connect-to> <message-size> <roundtrip-count>"
+    puts "usage: ruby remote_lat.rb <connect-to> <message-size> <roundtrip-count>"
     exit
   end
-
+  
+  def assert(rc)
+    raise "Last API call failed at #{caller(1)}" unless rc >= 0
+  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)
+  s   = ctx.socket ZMQ::REQ
+  rc  = s.connect(connect_to)
 
   msg = "#{ '3' * message_size }"
 
-  start_time = Time.now
+  time_start = Time.now
 
-  msg = ""
   roundtrip_count.times do
-    rc = s.send_string msg, 0
-    rc = s.recv_string msg
+    assert(s.send_string(msg, 0))
+  
+    msg = ''
+    assert(s.recv_string(msg, 0))
+  
     raise "Message size doesn't match, expected [#{message_size}] but received [#{msg.size}]" if message_size != msg.size
   end
 
+  time_end = Time.now
+  puts "Time #{( time_end - time_start )}"
+
 == Better Examples
 
 I highly recommend visiting the Learn Ruby 0mq project for a bunch of good code examples.
@@ -122,17 +154,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.
@@ -141,7 +171,7 @@ It will crash randomly and you will be sad.
 
 == INSTALL:
 
-Make sure the ZeroMQ library is already installed on your system.
+Make sure the ZeroMQ library is already installed on your system. We recommend 'brew' or 'macports' to get it.
 
  % gem install ffi-rzmq # should grab the latest release
 

data/Rakefile

@@ -4,3 +4,18 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
 
 task :default => :spec
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'ffi-rzmq'
+  ARGV.clear
+  IRB.start
+end
+
+task :pryconsole do
+  require 'pry'
+  require 'ffi-rzmq'
+  ARGV.clear
+  Pry.start
+end

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/repreq_over_curve.rb

@@ -0,0 +1,60 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'ffi-rzmq')
+
+# This example shows the basics of a CURVE-secured REP/REQ setup between
+# a Server and Client. This is the minimal required setup for authenticating
+# a connection between a Client and a Server. For validating the Client's authentication
+# once the initial connection has succeeded, you'll need a ZAP handler on the Server.
+
+# Build the Server's keys
+server_public_key, server_private_key = ZMQ::Util.curve_keypair
+
+# Build the Client's keys
+client_public_key, client_private_key = ZMQ::Util.curve_keypair
+
+context = ZMQ::Context.new
+bind_point = "tcp://127.0.0.1:4455"
+
+##
+# Configure the Server
+##
+server = context.socket ZMQ::REP
+
+server.setsockopt(ZMQ::CURVE_SERVER, 1)
+server.setsockopt(ZMQ::CURVE_SECRETKEY, server_private_key)
+
+server.bind(bind_point)
+
+##
+# Configure the Client to talk to the Server
+##
+client = context.socket ZMQ::REQ
+
+client.setsockopt(ZMQ::CURVE_SERVERKEY, server_public_key)
+client.setsockopt(ZMQ::CURVE_PUBLICKEY, client_public_key)
+client.setsockopt(ZMQ::CURVE_SECRETKEY, client_private_key)
+
+client.connect(bind_point)
+
+##
+# Show that communication still works
+##
+
+client_message = "Hello Server!"
+server_response = "Hello Client!"
+
+puts "Client sending: #{client_message}"
+client.send_string client_message
+
+server.recv_string(server_message = '')
+puts "Server received: #{server_message}, replying with #{server_response}"
+
+server.send_string(server_response)
+
+client.recv_string(response = '')
+puts "Client has received: #{response}"
+
+puts "Finished"
+
+client.close
+server.close
+context.terminate