ffi-rzmq 0.9.3 → 0.9.6

data/History.txt

@@ -1,3 +1,52 @@
+== 0.9.6 / 20120808
+  * Never released 0.9.5 as a gem. It was available via github only.
+  
+  * Improved error message when DLL loading fails on Windows.
+  
+  * Added support for 0mq 2.2. Support for 2.1 might be getting shakey...
+    patches to make it fully support 2.1 (assuming it's even broken at
+    all) are welcome.
+  
+  * Added support for 0mq 3.2 (no support for 3.0 or 3.1). Not all methods
+    are exposed yet. For example, setting values on the context after it
+    has been created is not supported; instead, pass the correct keys
+    (:io_threads and :max_sockets) to the call to Context.create or
+    Context#new.
+    
+  * Reduced spec running time from 30+ seconds to under 1 by eliminating
+    most uses of "sleep." It now polls sockets to wait for message
+    delivery. It also uses a technique of binding an inproc transport and
+    busy-looping on the connect side until it succeeds. These techniques
+    both allowed me to eliminate most uses of sleep.
+    
+  * Some changes to support usage on Win7x64 with a 64-bit libzmq DLL.
+
+== 0.9.5 / 20120119
+  * BROKE THE API.
+    In 0mq 2.x, there were two functions zmq_send() and zmq_recv().
+    As of 3.x, those functions were renamed zmq_sendmsg() and
+    zmq_recvmsg(). As everyone starts moving to 0mq 3.x, it doesn't
+    make sense to make the code break with 2.x. So, I'm breaking this
+    binding so that it always uses sendmsg/recvmsg and eliminates the
+    original send/recv methods.
+    Sorry!
+    This is likely to be the last non-backward-compatible API breakage.
+    Release 1.0 is around the corner and the API will be stable (I follow
+    semantic versioning).
+    
+  * Introduced ZMQ::NonBlocking. This flag returns the correct value to set
+    a socket in non-blocking mode when sending/receiving. This hides the
+    differences between 0mq 2.x and 3.x since the constant names have
+    changed.
+
+== 0.9.4 / 20120102
+  * Fixed bug in Poller#delete. Added specs to catch a regression.
+    In short, a socket that was deleted from the Poller set wasn't
+    always actually *removed* from the array. This led to a closed
+    socket being part of the pollset which would return errno 38.
+    This took about 4 days to find. <sigh>
+    
+
 == 0.9.3 / 20111214
   * Performance optimizations for #getsockopt.
   
@@ -15,6 +64,8 @@
     can avoid that work and dispatch directly. This effects all
     Ruby runtimes, but it was through the work of Evan Phoenix that
     I figured this out. Results in a 2-5% speedup on method dispatch.
+    
+  
 
 == 0.9.2 / 20111115
   * Removed all references to the version4 API.

data/README.rdoc

@@ -54,6 +54,14 @@ 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
 
 Check out the latest performance results:
@@ -93,13 +101,14 @@ All features are implemented.
   
   ctx = ZMQ::Context.new
   s = ctx.socket ZMQ::REP
-  s.setsockopt(ZMQ::HWM, 100)
-  s.bind(bind_to)
+  rc = s.setsockopt(ZMQ::HWM, 100)
+  rc = s.bind(bind_to)
   
+  msg = ""
   roundtrip_count.times do
-    msg = s.recv_string 0
+    rc = s.recv_string msg
     raise "Message size doesn't match, expected [#{message_size}] but received [#{msg.size}]" if message_size != msg.size
-    s.send_string msg, 0
+    rc = s.send_string msg, 0
   end
   
 
@@ -119,15 +128,16 @@ All features are implemented.
   
   ctx = ZMQ::Context.new
   s = ctx.socket ZMQ::REQ
-  s.connect(connect_to)
+  rc = s.connect(connect_to)
   
   msg = "#{ '3' * message_size }"
   
   start_time = Time.now
   
+  msg = ""
   roundtrip_count.times do
-    s.send_string msg, 0
-    msg = s.recv_string 0
+    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
   

data/examples/v2api/local_lat_poll.rb

@@ -38,7 +38,7 @@ start_time = Time.now
 
 # kick it off
 message = ZMQ::Message.new("a" * message_size)
-assert(s1.send(message, ZMQ::NOBLOCK))
+assert(s1.sendmsg(message, ZMQ::NonBlocking))
 
 i = roundtrip_count
 
@@ -49,8 +49,8 @@ until i.zero?
 
   poller.readables.each do |socket|
     received_message = ''
-    assert(socket.recv_string(received_message, ZMQ::NOBLOCK))
-    assert(socket.send(ZMQ::Message.new(received_message), ZMQ::NOBLOCK))
+    assert(socket.recv_string(received_message, ZMQ::NonBlocking))
+    assert(socket.sendmsg(ZMQ::Message.new(received_message), ZMQ::NonBlocking))
   end
 end
 

data/examples/v2api/local_throughput.rb

@@ -28,13 +28,13 @@ assert(s.setsockopt(ZMQ::SUBSCRIBE, ""))
 assert(s.bind(bind_to))
 
 msg = ZMQ::Message.new
-assert(s.recv(msg))
+assert(s.recvmsg(msg))
 
 start_time = Time.now
 
 i = 1
 while i < message_count
-  assert(s.recv(msg))
+  assert(s.recvmsg(msg))
   i += 1
 end
 

data/examples/v2api/pub.rb

@@ -0,0 +1,46 @@
+
+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>"
+  Process.exit
+end
+
+connect_to = ARGV[0]
+message_size = ARGV[1].to_i
+message_count = ARGV[2].to_i
+
+def assert(rc)
+  raise "Last API call failed at #{caller(1)}" unless rc >= 0
+end
+
+begin
+  ctx = ZMQ::Context.new
+  s = ZMQ::Socket.new(ctx.pointer, ZMQ::PUB)
+rescue ContextError => e
+  STDERR.puts "Could not allocate a context or socket!"
+  raise
+end
+
+#assert(s.setsockopt(ZMQ::LINGER, 1_000))
+#assert(s.setsockopt(ZMQ::RCVHWM, 0))
+assert(s.setsockopt(ZMQ::HWM, 10))
+assert(s.bind(connect_to))
+
+# the sleep gives the downstream SUB socket a chance to register its
+# subscription filters with this PUB socket
+puts "Hit any key to start publishing"
+STDIN.gets
+
+i = 0
+while i < message_count
+  msg = ZMQ::Message.new(i.to_s)
+  assert(s.sendmsg(msg))
+  puts i
+  i += 1
+end
+
+sleep 10
+assert(s.close)
+
+ctx.terminate

data/examples/v2api/publish_subscribe.rb

@@ -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::NOBLOCK)
+rc = s5.recv_string(s5_string, ZMQ::NonBlocking)
 eagain = (rc == -1 && ZMQ::Util.errno == ZMQ::EAGAIN)
 puts(eagain ? "s5 received no messages" : "s5 FAILED")
 

data/examples/v2api/remote_throughput.rb

@@ -30,7 +30,7 @@ contents = "#{'0'*message_size}"
 i = 0
 while i < message_count
   msg = ZMQ::Message.new(contents)
-  assert(s.send(msg))
+  assert(s.sendmsg(msg))
   i += 1
 end
 

data/examples/v2api/reqrep_poll.rb

@@ -38,7 +38,7 @@ until @done do
     payload = "#{ '3' * 1024 }"
 
     puts "sending payload nonblocking"
-    assert(s1.send_string(payload, ZMQ::NOBLOCK))
+    assert(s1.send_string(payload, ZMQ::NonBlocking))
     @unsent = false
   end
 
@@ -46,7 +46,7 @@ until @done do
   if Time.now - start_time > 1
     poller.readables.each do |sock|
       received_msg = ''
-      assert(sock.recv_string(received_msg, ZMQ::NOBLOCK))
+      assert(sock.recv_string(received_msg, ZMQ::NonBlocking))
 
       puts "message received [#{received_msg}]"
       @done = true

data/examples/v2api/request_response.rb

@@ -27,8 +27,8 @@ payload = "#{ '3' * 2048 }"
 sent_msg = ZMQ::Message.new(payload)
 received_msg = ZMQ::Message.new
 
-assert(s1.send(sent_msg))
-assert(s2.recv(received_msg))
+assert(s1.sendmsg(sent_msg))
+assert(s2.recvmsg(received_msg))
 
 result = payload == received_msg.copy_out_string ? "Request received" : "Received wrong payload"
 

data/examples/v2api/sub.rb

@@ -0,0 +1,74 @@
+
+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
+end
+
+bind_to = ARGV[0]
+message_size = ARGV[1].to_i
+message_count = ARGV[2].to_i
+sleep_time = ARGV[3].to_f
+
+begin
+  ctx = ZMQ::Context.new
+  s = ZMQ::Socket.new(ctx.pointer, ZMQ::SUB)
+rescue ContextError => e
+  STDERR.puts "Failed to allocate context or socket!"
+  raise
+end
+
+#assert(s.setsockopt(ZMQ::LINGER, 100))
+assert(s.setsockopt(ZMQ::IDENTITY, rand(999_999).to_s))
+assert(s.setsockopt(ZMQ::SUBSCRIBE, ""))
+assert(s.setsockopt(ZMQ::HWM, 1))
+#assert(s.setsockopt(ZMQ::RCVHWM, 0))
+#assert(s.setsockopt(ZMQ::SNDHWM, 0))
+
+assert(s.connect(bind_to))
+sleep 1
+
+msg = ZMQ::Message.new
+msg = ''
+assert(s.recv_string(msg))
+raise unless msg.to_i == 0
+
+start_time = Time.now
+
+i = 1
+while i < message_count - 1
+  assert(s.recv_string(msg))
+  msg_i = msg.to_i
+  missed = (msg_i - i) - 1
+  puts "missed [#{missed}] messages" if missed > 0
+  i = msg_i
+  
+  start = Time.now
+  while (Time.now - start) < sleep_time
+  end
+end
+
+end_time = Time.now
+
+elapsed = (end_time.to_f - start_time.to_f) * 1000000
+if elapsed == 0
+  elapsed = 1
+end
+
+throughput = message_count * 1000000 / elapsed
+megabits = throughput * message_size * 8 / 1000000
+
+puts "message size: %i [B]" % message_size
+puts "message count: %i" % message_count
+puts "mean throughput: %i [msg/s]" % throughput
+puts "mean throughput: %.3f [Mb/s]" % megabits
+
+assert(s.close)
+
+ctx.terminate

data/examples/v2api/throughput_measurement.rb

@@ -58,11 +58,11 @@ class Receiver
 
   def run
     msg = ZMQ::Message.new
-    assert(@socket.recv(msg))
+    assert(@socket.recvmsg(msg))
 
     elapsed = elapsed_microseconds do
       (@count -1).times do
-        assert(@socket.recv(msg))
+        assert(@socket.recvmsg(msg))
       end
     end
 
@@ -110,7 +110,7 @@ class Transmitter
     i = 0
     while i < @count
       msg = ZMQ::Message.new(contents)
-      assert(@socket.send(msg))
+      assert(@socket.sendmsg(msg))
       i += 1
     end
 

data/examples/v2api/xreqxrep_poll.rb

@@ -43,7 +43,7 @@ until @done do
 
     5.times do |i|
       payload = "#{ i.to_s * 40 }"
-      assert(s1.send_string(payload, ZMQ::NOBLOCK))
+      assert(s1.send_string(payload, ZMQ::NonBlocking))
     end
     @unsent = false
   end
@@ -54,12 +54,12 @@ until @done do
 
       if sock.identity =~ /xrep/
         routing_info = ''
-        assert(sock.recv_string(routing_info, ZMQ::NOBLOCK))
+        assert(sock.recv_string(routing_info, ZMQ::NonBlocking))
         puts "routing_info received [#{routing_info}] on socket.identity [#{sock.identity}]"
       else
         routing_info = nil
         received_msg = ''
-        assert(sock.recv_string(received_msg, ZMQ::NOBLOCK))
+        assert(sock.recv_string(received_msg, ZMQ::NonBlocking))
 
         # skip to the next iteration if received_msg is nil; that means we got an EAGAIN
         next unless received_msg
@@ -68,13 +68,13 @@ until @done do
 
       while sock.more_parts? do
         received_msg = ''
-        assert(sock.recv_string(received_msg, ZMQ::NOBLOCK))
+        assert(sock.recv_string(received_msg, ZMQ::NonBlocking))
 
         puts "message received [#{received_msg}]"
       end
 
       puts "kick back a reply"
-      assert(sock.send_string(routing_info, ZMQ::SNDMORE | ZMQ::NOBLOCK)) if routing_info
+      assert(sock.send_string(routing_info, ZMQ::SNDMORE | ZMQ::NonBlocking)) 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/examples/v3api/local_lat_poll.rb

@@ -38,7 +38,7 @@ start_time = Time.now
 
 # kick it off
 message = ZMQ::Message.new("a" * message_size)
-assert(s1.sendmsg(message, ZMQ::DONTWAIT))
+assert(s1.sendmsg(message, ZMQ::NonBlocking))
 
 i = roundtrip_count
 
@@ -49,8 +49,8 @@ until i.zero?
 
   poller.readables.each do |socket|
     received_message = ''
-    assert(socket.recv_string(received_message, ZMQ::DONTWAIT))
-    assert(socket.sendmsg(ZMQ::Message.new(received_message), ZMQ::DONTWAIT))
+    assert(socket.recv_string(received_message, ZMQ::NonBlocking))
+    assert(socket.sendmsg(ZMQ::Message.new(received_message), ZMQ::NonBlocking))
   end
 end
 

data/examples/v3api/pub.rb

@@ -0,0 +1,46 @@
+
+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>"
+  Process.exit
+end
+
+connect_to = ARGV[0]
+message_size = ARGV[1].to_i
+message_count = ARGV[2].to_i
+
+def assert(rc)
+  raise "Last API call failed at #{caller(1)}" unless rc >= 0
+end
+
+begin
+  ctx = ZMQ::Context.new
+  s = ZMQ::Socket.new(ctx.pointer, ZMQ::PUB)
+rescue ContextError => e
+  STDERR.puts "Could not allocate a context or socket!"
+  raise
+end
+
+#assert(s.setsockopt(ZMQ::LINGER, 1_000))
+#assert(s.setsockopt(ZMQ::RCVHWM, 0))
+assert(s.setsockopt(ZMQ::SNDHWM, 100))
+assert(s.bind(connect_to))
+
+# the sleep gives the downstream SUB socket a chance to register its
+# subscription filters with this PUB socket
+puts "Hit any key to start publishing"
+STDIN.gets
+
+i = 0
+while i < message_count
+  msg = ZMQ::Message.new(i.to_s)
+  assert(s.sendmsg(msg))
+  puts i
+  i += 1
+end
+
+sleep 10
+assert(s.close)
+
+ctx.terminate