cztop 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb0ba59995fcb10d5dd7054d72ba49cf886281ea
-  data.tar.gz: deea479538b525d5f92673bd694b8d34f5b8e7d8
+  metadata.gz: a0a723ca2a3e3272f97e72dbf4b90ce750d56240
+  data.tar.gz: 579445f67959d4cd7f8db0166adff18881d01273
 SHA512:
-  metadata.gz: 1849347983836cf93974f9f51d41147a1cacd6e4950b77b8ebac2a62429827b58fff40e8de41fe6c16cc44c8663c4009b8e20f44fe74c00956047885ccc21a73
-  data.tar.gz: e278d6d22d69c2e0f83bbaaed62057be6883a175749eee567aafd8343fde586cf3cb812c5e8e75e56ad56ec6808abd4617a907dc11f4ce06e5f1091fd167e4f7
+  metadata.gz: 0431bec1dd537a65ba20467226cb430a3affb229319da0aaefaf2d114e72a613a3f72fc579e43c8449ec0ccb3e473e7ef9e65b8b8ddb1e77d501b63fc9d4be8f
+  data.tar.gz: 0ae5624063f633046af71f27123b789bf1d547f713f6c87a2050c752c49f722ad30b03867ea754bf46a1943df7b7d05ec2e0cf18155c84730fcb624ad875ebbb

data/.travis.yml

@@ -8,6 +8,7 @@ rvm:
   - 2.3.0
   - 2.2.4
   - 2.1.8
+  - 2.0.0-p648
   - jruby-head
   - rbx
 env:

data/README.md

@@ -64,6 +64,7 @@ Here are some some of the goals I have/had in mind for this library:
 - [x] provide a portable Z85 implementation
   * unlike [fpesce/z85](https://github.com/fpesce/z85), which is a C extension
 - [ ] use it to replace the [Celluloid::ZMQ](https://github.com/celluloid/celluloid-zmq) part of [Celluloid](https://github.com/celluloid/celluloid)
+  * [celluloid/celluloid-zmq#56](https://github.com/celluloid/celluloid-zmq/issues/56)
 - [ ] implement some of the missing (CZMQ based) Ruby examples in the [ZMQ Guide](http://zguide.zeromq.org/page:all)
 
 ## Overview
@@ -72,34 +73,34 @@ Here are some some of the goals I have/had in mind for this library:
 
 Here's an overview of the core classes:
 
-* CZTop
-  * Actor
-  * Authentiator < Actor
-  * Beacon < Actor
-  * Certificate
-  * Config
-  * Frame
-  * Message
-  * Monitor < Actor
-  * Proxy < Actor
-  * Poller
-  * Socket
-    * REQ < Socket
-    * REP < Socket
-    * ROUTER < Socket
-    * DEALER < Socket
-    * PUSH < Socket
-    * PULL < Socket
-    * PUB < Socket
-    * SUB < Socket
-    * XPUB < Socket
-    * XSUB < Socket
-    * PAIR < Socket
-    * STREAM < Socket
-    * CLIENT < Socket
-    * SERVER < Socket
-  * Z85
-    * Padded < Z85
+* [CZTop](http://www.rubydoc.info/gems/cztop/CZTop)
+  * [Actor](http://www.rubydoc.info/gems/cztop/CZTop)
+  * [Authentiator](http://www.rubydoc.info/gems/cztop/CZTop/Authenticator) < Actor
+  * [Beacon](http://www.rubydoc.info/gems/cztop/CZTop/Beacon) < Actor
+  * [Certificate](http://www.rubydoc.info/gems/cztop/CZTop/Certificate)
+  * [Config](http://www.rubydoc.info/gems/cztop/CZTop/Config)
+  * [Frame](http://www.rubydoc.info/gems/cztop/CZTop/Frame)
+  * [Message](http://www.rubydoc.info/gems/cztop/CZTop/Message)
+  * [Monitor](http://www.rubydoc.info/gems/cztop/CZTop/Monitor) < Actor
+  * [Proxy](http://www.rubydoc.info/gems/cztop/CZTop/Proxy) < Actor
+  * [Poller](http://www.rubydoc.info/gems/cztop/CZTop/Poller)
+  * [Socket](http://www.rubydoc.info/gems/cztop/CZTop/Socket)
+    * [REQ](http://www.rubydoc.info/gems/cztop/CZTop/Socket/REQ) < Socket
+    * [REP](http://www.rubydoc.info/gems/cztop/CZTop/Socket/REP) < Socket
+    * [ROUTER](http://www.rubydoc.info/gems/cztop/CZTop/Socket/ROUTER) < Socket
+    * [DEALER](http://www.rubydoc.info/gems/cztop/CZTop/Socket/DEALER) < Socket
+    * [PUSH](http://www.rubydoc.info/gems/cztop/CZTop/Socket/PUSH) < Socket
+    * [PULL](http://www.rubydoc.info/gems/cztop/CZTop/Socket/PULL) < Socket
+    * [PUB](http://www.rubydoc.info/gems/cztop/CZTop/Socket/PUB) < Socket
+    * [SUB](http://www.rubydoc.info/gems/cztop/CZTop/Socket/SUB) < Socket
+    * [XPUB](http://www.rubydoc.info/gems/cztop/CZTop/Socket/XPUB) < Socket
+    * [XSUB](http://www.rubydoc.info/gems/cztop/CZTop/Socket/XSUB) < Socket
+    * [PAIR](http://www.rubydoc.info/gems/cztop/CZTop/Socket/PAIR) < Socket
+    * [STREAM](http://www.rubydoc.info/gems/cztop/CZTop/Socket/STREAM) < Socket
+    * [CLIENT](http://www.rubydoc.info/gems/cztop/CZTop/Socket/CLIENT) < Socket
+    * [SERVER](http://www.rubydoc.info/gems/cztop/CZTop/Socket/SERVER) < Socket
+  * [Z85](http://www.rubydoc.info/gems/cztop/CZTop/Z85)
+    * [Padded](http://www.rubydoc.info/gems/cztop/CZTop/Z85/Padded) < Z85
 
 More information in the [API documentation](http://www.rubydoc.info/github/paddor/cztop).
 
@@ -185,7 +186,7 @@ is tested.
 
 At the time of writing, these include:
 
-* MRI (2.3, 2.2.4, 2.1.8)
+* MRI (2.3, 2.2.4, 2.1.8, 2.0.0)
 * Rubinius (HEAD)
 * JRuby 9000 (HEAD)
 
@@ -205,6 +206,30 @@ Or install it yourself as:
 
     $ gem install cztop
 
+## Documentation
+
+The API should be fairly straight-forward to anyone who is familiar with CZMQ
+and Ruby.  The following API documentation is currently available:
+
+* [YARD API documentation](http://www.rubydoc.info/github/paddor/cztop) (HEAD)
+* [YARD API documentation](http://www.rubydoc.info/gems/cztop) (release)
+
+Feel free to start a [wiki](https://github.com/paddor/cztop/wiki) page.
+
+## Performance
+
+Performance should be pretty okay since this is based on czmq-ffi-gen, which is
+reasonably thin.  CZTop is basically only a convenience layer on top, with some
+nice error checking. But hey, it's Ruby. Don't expect 5M messages per second
+with a latency of 3us.
+
+The measured latency on my laptop ranges from ~20us to ~60us per message for
+1kb messages, depending on whether transport is inproc, IPC, or TCP/IP.
+
+Make sure you check out the
+[perf](https://github.com/paddor/cztop/blob/master/perf) directory for latency
+and throughput measurement scripts.
+
 ## Usage
 
 See the [examples](https://github.com/paddor/cztop/blob/master/examples) directory for some examples. Here's a very simple one:
@@ -213,7 +238,7 @@ See the [examples](https://github.com/paddor/cztop/blob/master/examples) directo
 
 ```ruby
 #!/usr/bin/env ruby
-require_relative '../../lib/cztop'
+require 'cztop'
 
 # create and bind socket
 socket = CZTop::Socket::REP.new("ipc:///tmp/req_rep_example")
@@ -230,7 +255,7 @@ end
 
 ```ruby
 #!/usr/bin/env ruby
-require_relative '../../lib/cztop'
+require 'cztop'
 
 # connect
 socket = CZTop::Socket::REQ.new("ipc:///tmp/req_rep_example")
@@ -288,29 +313,6 @@ $ ./rep.rb & ./req.rb 3
 $
 ```
 
-## Documentation
-
-The API should be fairly straight-forward to anyone who is familiar with CZMQ
-and Ruby.  The following API documentation is currently available:
-
-* [YARD API documentation](http://www.rubydoc.info/github/paddor/cztop)
-
-Feel free to start a [wiki](https://github.com/paddor/cztop/wiki) page.
-
-## Performance
-
-Performance should be pretty okay since this is based on czmq-ffi-gen, which is
-reasonably thin.  CZTop is basically only a convenience layer on top, with some
-nice error checking. But hey, it's Ruby. Don't expect 5M messages per second
-with a latency of 3us.
-
-The measured latency on my laptop ranges from ~20us to ~60us per message for
-1kb messages, depending on whether transport is inproc, IPC, or TCP/IP.
-
-Make sure you check out the
-[perf](https://github.com/paddor/cztop/blob/master/perf) directory for latency
-and throughput measurement scripts.
-
 ## TODO
 
 * [x] pack generated code into its own gem ([czmq-ffi-gen](https://github.com/paddor/czmq-ffi-gen))
@@ -373,27 +375,20 @@ and throughput measurement scripts.
       * [x] adapt czmq-ffi-gen so it doesn't raise while `attach_function`, attach `zsys_has_curve()` instead (under same name)
     * [x] adapt test suite to skip affected test examples
     * [x] test on CI
-* [x] port Poller to `zmq_poll()`
+* [x] port [Poller](http://www.rubydoc.info/gems/cztop/CZTop/Poller) to `zmq_poll()`
   * backwards compatible (`#add_reader`, `#add_writer`, `#wait` behave the same)
   * but in addition, it has `#readables` and `#writables` which return arrays of sockets
-  * level-triggered (not sure if `zmq_poll()` itelf is, but it'll be trivial)
   * could then be used in Celluloid::ZMQ
-  * want to use `zmq_poller()` because it can deal with CLIENT/SERVER sockets and is the future
-    * but can't use it because
-      * it doesn't allow me to get all readable/writable sockets back after one call to `#wait`
-      * can't just recall `#wait` with zero timeout until it says there are no
-	more, because ZMQ sockets (option ZMQ_FD) are edge-triggered :-(
-    * maybe I don't really need that functionality, though
-    * can't use `zpoller`, because it doesn't support polling for writing
 * [ ] add `Message#to_s`
   * return frame as string, if there's only one frame
   * raise if there are multiple frames
   * only safe to use on messages from SERVER/CLIENT sockets
   * single-part messages are the future
+  * not sure yet
 * [x] get rid of Loop
-  * cannot handle SERVER socket
-  * there are other timer libraries for Ruby
-  * Poller can be used to embed in an existing event loop (Celluloid), or make your own trivial one.
+  * cannot handle CLIENT/SERVER sockets
+  * there good timer gems for Ruby
+  * Poller can be used to embed in an existing event loop (Celluloid), or make your own trivial one
 
 ## Contributing
 

data/examples/ruby_actor/actor.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require_relative '../../lib/cztop'
+require 'cztop'
 
 ##
 # This example shows how to create a simple actor using a Ruby block.

data/examples/simple_req_rep/rep.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require_relative '../../lib/cztop'
+require 'cztop'
 
 # create and bind socket
 socket = CZTop::Socket::REP.new("ipc:///tmp/req_rep_example")

data/examples/simple_req_rep/req.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require_relative '../../lib/cztop'
+require 'cztop'
 
 # connect
 socket = CZTop::Socket::REQ.new("ipc:///tmp/req_rep_example")

data/examples/taxi_system/README.md

@@ -47,7 +47,7 @@ that it cannot do so.
 #!/usr/bin/env ruby
 require 'pry'
 require 'pathname'
-require_relative '../../lib/cztop'
+require 'cztop'
 
 endpoint = ENV["BROKER_ADDRESS"]
 broker_cert = CZTop::Certificate.load ENV["BROKER_CERT"] # secret+public
@@ -157,7 +157,7 @@ requests) and prints them into the terminal.
 
 ```ruby
 #!/usr/bin/env ruby
-require_relative '../../lib/cztop'
+require 'cztop'
 
 endpoint = ENV["BROKER_ADDRESS"]
 broker_cert = CZTop::Certificate.load ENV["BROKER_CERT"] # public only
@@ -204,7 +204,7 @@ need to know the clients' secret keys just to authenticate them.
 
 ```ruby
 #!/usr/bin/env ruby
-require_relative '../../lib/cztop'
+require 'cztop'
 require 'fileutils'
 FileUtils.cd(File.dirname(__FILE__))
 FileUtils.mkdir "public_keys"

data/examples/taxi_system/broker.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 require 'pry'
 require 'pathname'
-require_relative '../../lib/cztop'
+require 'cztop'
 
 endpoint = ENV["BROKER_ADDRESS"]
 broker_cert = CZTop::Certificate.load ENV["BROKER_CERT"] # secret+public

data/examples/taxi_system/client.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require_relative '../../lib/cztop'
+require 'cztop'
 
 endpoint = ENV["BROKER_ADDRESS"]
 broker_cert = CZTop::Certificate.load ENV["BROKER_CERT"] # public only

data/examples/taxi_system/generate_keys.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require_relative '../../lib/cztop'
+require 'cztop'
 require 'fileutils'
 FileUtils.cd(File.dirname(__FILE__))
 FileUtils.mkdir "public_keys"

data/lib/cztop/authenticator.rb

@@ -8,7 +8,7 @@ module CZTop
   class Authenticator
     include ::CZMQ::FFI
 
-    # function pointer to the `zauth()` function
+    # function pointer to the +zauth()+ function
     ZAUTH_FPTR = ::CZMQ::FFI.ffi_libraries.each do |dl|
       fptr = dl.find_function("zauth")
       break fptr if fptr

data/lib/cztop/beacon.rb

@@ -7,7 +7,7 @@ module CZTop
   class Beacon
     include ::CZMQ::FFI
 
-    # function pointer to the `zbeacon()` function
+    # function pointer to the +zbeacon()+ function
     ZBEACON_FPTR = ::CZMQ::FFI.ffi_libraries.each do |dl|
       fptr = dl.find_function("zbeacon")
       break fptr if fptr

data/lib/cztop/message.rb

@@ -32,6 +32,14 @@ module CZTop
       content_size.zero?
     end
 
+    # Support Ruby 2.0
+    unless defined?(::IO::EAGAINWaitWritable)
+      class ::IO::EAGAINWaitWritable < Errno::EAGAIN
+      end
+      class ::IO::EAGAINWaitReadable < Errno::EAGAIN
+      end
+    end
+
     # Send {Message} to a {Socket} or {Actor}.
     #
     # @note Do NOT use this {Message} anymore afterwards. Its native

data/lib/cztop/monitor.rb

@@ -12,7 +12,7 @@ module CZTop
   class Monitor
     include ::CZMQ::FFI
 
-    # function pointer to the `zmonitor()` function
+    # function pointer to the +zmonitor()+ function
     ZMONITOR_FPTR = ::CZMQ::FFI.ffi_libraries.each do |dl|
       fptr = dl.find_function("zmonitor")
       break fptr if fptr

data/lib/cztop/poller.rb

@@ -7,13 +7,13 @@ module CZTop
   # Celluloid::ZMQ::Reactor#run_once all readable/writable sockets need to be
   # processed.
   #
-  # This implementation is NOT based on zpoller. Reasons:
+  # This implementation is NOT based on CZMQ's +zpoller+. Reasons:
   #
-  # * zpoller can only poll for reading
+  # * +zpoller+ can only poll for reading
   #
-  # It's also NOT based on `zmq_poller()`. Reasons:
+  # It's also NOT based on +zmq_poller()+. Reasons:
   #
-  # * zmq_poller() doesn't exist in older versions of ZMQ < 4.2
+  # * +zmq_poller()+ doesn't exist in older versions of ZMQ < 4.2
   #
   # Possible future implementation on +zmq_poller()+ might work like this, to
   # support getting an array of readable/writable sockets:
@@ -188,7 +188,7 @@ module CZTop
 
     private
 
-    # Rebuilds the list of `poll_item_t`.
+    # Rebuilds the list of +poll_item_t+.
     # @return [void]
     def rebuild
       @nitems = @readers.size + @writers.size

data/lib/cztop/proxy.rb

@@ -8,7 +8,7 @@ module CZTop
   class Proxy
     include ::CZMQ::FFI
 
-    # function pointer to the `zmonitor()` function
+    # function pointer to the +zmonitor()+ function
     ZPROXY_FPTR = ::CZMQ::FFI.ffi_libraries.each do |dl|
       fptr = dl.find_function("zproxy")
       break fptr if fptr

data/lib/cztop/version.rb

@@ -1,3 +1,3 @@
 module CZTop
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/perf/README.md

@@ -5,7 +5,7 @@ This directory contains simple performance measurement utilities:
 - `inproc_lat.rb` measures the latency of the inproc transport
 - `inproc_thr.rb` measures the throughput of the inproc transport
 - `local_lat.rb` and `remote_lat.rb` measure the latency other transports
-- `local_thr.rb` and `remote_thr.rb` measure the throughput other transports
+- `local_thr.rb` and `remote_thr.rb` measure the throughput other transports (TODO)
 
 ## Example Output
 
@@ -15,7 +15,7 @@ On my laptop, it currently looks something like this:
 
 over inproc, using 10k roundtrips of a repeatedly allocated 1kb message:
 ```
-$ ./inproc_lat_reqrep.rb 1_000 10_000
+$ bundle exec ./inproc_lat_reqrep.rb 1_000 10_000
 message size: 1000 [B]
 roundtrip count: 10000
 elapsed time: 0.469 [s]
@@ -24,7 +24,7 @@ average latency: 23.439 [us]<Paste>
 
 over IPC, using 10k roundtrips of a repeatedly allocated 1kb message:
 ```
-$ ./local_lat.rb ipc:///tmp/cztop-perf 1000 1000 & ./remote_lat.rb ipc:///tmp/cztop-perf 1000 1000
+$ bundle exec ./local_lat.rb ipc:///tmp/cztop-perf 1000 1000 & ./remote_lat.rb ipc:///tmp/cztop-perf 1000 1000
 [3] 58043
 message size: 1000 [B]
 roundtrip count: 1000
@@ -36,6 +36,7 @@ average latency: 45.482 [us]
 over local TCP/IP stack, using 10k roundtrips of a repeatedly allocated
 1kb message:
 ```
+$ bundle exec ./local_lat.rb tcp://127.0.0.1:55667 1000 1000 & ./remote_lat.rb tcp://127.0.0.1:55667 1000 1000
 [3] 58064
 message size: 1000 [B]
 roundtrip count: 1000
@@ -49,28 +50,28 @@ average latency: 61.434 [us]
 over inproc, with message sizes from 100 bytes to 100kb, 10,000 each:
 
 ```
-$ ./inproc_thru.rb 100 10_000
+$ bundle exec ./inproc_thru.rb 100 10_000
 message size: 100 [B]
 message count: 10000
 elapsed time: 0.270 [s]
 mean throughput: 37093 [msg/s]
 mean throughput: 29.674 [Mb/s]
 
-$ ./inproc_thru.rb 1_000 10_000
+$ bundle exec ./inproc_thru.rb 1_000 10_000
 message size: 1000 [B]
 message count: 10000
 elapsed time: 0.260 [s]
 mean throughput: 38498 [msg/s]
 mean throughput: 307.987 [Mb/s]
 
-$ ./inproc_thru.rb 10_000 10_000
+$ bundle exec ./inproc_thru.rb 10_000 10_000
 message size: 10000 [B]
 message count: 10000
 elapsed time: 0.317 [s]
 mean throughput: 31501 [msg/s]
 mean throughput: 2520.102 [Mb/s]
 
-$ ./inproc_thru.rb 100_000 10_000
+$ bundle exec ./inproc_thru.rb 100_000 10_000
 message size: 100000 [B]
 message count: 10000
 elapsed time: 0.906 [s]

data/perf/inproc_lat.rb

@@ -1,5 +1,5 @@
 #! /usr/bin/env ruby
-require_relative "../lib/cztop"
+require "cztop"
 require "benchmark"
 #require "ruby-prof"
 

data/perf/inproc_thru.rb

@@ -1,5 +1,5 @@
 #! /usr/bin/env ruby
-require_relative "../lib/cztop"
+require "cztop"
 require "benchmark"
 
 if ARGV.size != 2

data/perf/local_lat.rb

@@ -1,5 +1,5 @@
 #! /usr/bin/env ruby
-require_relative "../lib/cztop"
+require "cztop"
 require "benchmark"
 
 if ARGV.size != 3

data/perf/remote_lat.rb

@@ -1,5 +1,5 @@
 #! /usr/bin/env ruby
-require_relative "../lib/cztop"
+require "cztop"
 require "benchmark"
 
 if ARGV.size != 3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cztop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Patrik Wenger