cztop 0.12.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 575a0a5ad125c607c8c85eaf8ac521a5894ef4cc
-  data.tar.gz: 72f3c5ecfe8e9d8f241d8b6e35ac992d2e194251
+SHA256:
+  metadata.gz: '0099b49a3147e57b4e29b8ca7288370f56e06694230c2f390e36308ac1f0cb1e'
+  data.tar.gz: d4431ae33cc4c35f9911d755d4377913f502156c26317b04a720c598f1f3eb3b
 SHA512:
-  metadata.gz: 810554c984e812f6eb6b7dfc74372022a1fedf08d7c30dc1287a7751f8802e9cd9593591826a7ca85f8c40b76967ba20da3c33bd679843a8de574b3fa9a5c536
-  data.tar.gz: 78b7fa8237b317994884af6a4f40ac96c9412f28c1f5b23fe0f1b023e3f5785fa86dd1af7f1674e0d95b924eca8d15fae565317370973d54eafcd974fdc79116
+  metadata.gz: 48f93f12b32aaed87a7cdbdf3f83ff064e69f1fef3e27e4dfaee21a7d721698bd8e7e1675d6fa1110b7597ae7651d971d4502b631a5505345cbb0dbf8ecc19e8
+  data.tar.gz: 90540f6ccab41b27361fc1372feb5198351a725b20a69509285ed459073f438a149a7e5e11043a1936b978610c664a0f7096bbb27c6801054cb85ff6fcd6a0b4

data/.github/workflows/main.yml

@@ -0,0 +1,26 @@
+name: Specs
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        ruby:
+          - "2.6"
+          - "2.7"
+          - "3.0"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby ${{ matrix.ruby }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install CZMQ
+      run: sudo apt install libczmq-dev
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.ruby-version

@@ -0,0 +1 @@
+3.0

data/CHANGES.md

@@ -1,3 +1,33 @@
+1.0.0 (01/08/2021)
+-----
+* modernized project
+
+0.13.1 (03/04/2018)
+-----
+* fix specs
+
+0.13.0 (03/04/2018)
+-----
+* use czmq-ffi-gen 0.15.x
+* CZTop::Monitor#listen: removed HANDSHAKE_FAILED and HANDSHAKE_SUCCEED events
+  and added HANDSHAKE_SUCCEEDED, HANDSHAKE_FAILED_NO_DETAIL,
+  HANDSHAKE:FAILED_PROTOCOL, HANDSHAKE_FAILED_AUTH to reflect changes in CZMQ
+* add CZTop::Monitor#fd and #readable?
+* add CZTop::ZsockOptions#fd (so #fd can be called on Sockets and Actors directly)
+* CZTop::Message#to_a: create less intermediate objects
+* support ZMQ_RECONNECT_IVL option
+* CZTop::Frame#group: return nil if group string is empty
+
+0.12.2 (11/24/2017)
+-----
+* no changes, but this release includes an up-to-date version of this file
+
+0.12.1 (11/23/2017)
+-----
+* actually include the change for CZTop::Poller#wait documented in 0.12.0
+* more robust specs around CZTop::Monitor
+* test recent rubies on CI
+
 0.12.0 (11/23/2017)
 -----
 * CZTop::Monitor#listen: accept HANDSHAKE_FAILED and HANDSHAKE_SUCCEED events

data/Gemfile

@@ -2,13 +2,4 @@ source 'https://rubygems.org'
 gemspec
 
 # useful when working on czmq-ffi-gen in parallel
-#gem "czmq-ffi-gen", git: "https://github.com/paddor/czmq-ffi-gen.git"
-#gem "rspec-core", git: "file:///Users/paddor/src/ruby/rspec-core"
-
-group :development do
-  gem 'rubocop', require: false
-  gem 'coveralls', require: false, platform: :mri
-
-  # >= 3.1 doesn't work on Rubinius, see guard/listen#391
-  gem 'listen', '~> 3.0.x', require: false
-end
+# gem "czmq-ffi-gen", path: "../czmq-ffi-gen"

data/README.md

@@ -1,3 +1,5 @@
+![Specs status](https://github.com/paddor/cztop/workflows/Specs/badge.svg)
+
 # CZTop
 
 CZTop is a CZMQ binding for Ruby. It is based on
@@ -6,33 +8,6 @@ FFI binding of [CZMQ](https://github.com/zeromq/czmq) and has a focus on being
 easy to use for Rubyists (POLS) and providing first class support for security
 mechanisms (like CURVE).
 
-You might wanna check out
-[cztop-patterns](https://github.com/paddor/cztop-patterns). It's still very
-new, but will contain some reusable patterns described in the Zguide.
-
-[![Build Status on Travis CI](https://travis-ci.org/paddor/cztop.svg?branch=master)](https://travis-ci.org/paddor/cztop?branch=master)
-[![Code Climate](https://codeclimate.com/repos/56677a7849f50a141c001784/badges/48f3cca3c62df9e4b17b/gpa.svg)](https://codeclimate.com/repos/56677a7849f50a141c001784/feed)
-[![Inline docs](http://inch-ci.org/github/paddor/cztop.svg?branch=master&style=shields)](http://inch-ci.org/github/paddor/cztop)
-[![Dependency Status](https://gemnasium.com/paddor/cztop.svg)](https://gemnasium.com/paddor/cztop)
-[![Coverage Status](https://coveralls.io/repos/paddor/cztop/badge.svg?branch=master&service=github)](https://coveralls.io/github/paddor/cztop?branch=master)
-[![ISC License](https://img.shields.io/badge/license-ISC_License-blue.svg)](LICENSE)
-
-## Goals
-
-Here are some some of the goals I have/had in mind for this library:
-
-- [x] as easy as possible, Ruby-esque API
-- [x] first class support for security (CURVE mechanism)
-  - [x] including handling of certificates
-- [x] support MRI, Rubinius, and JRuby
-- [x] high-quality API documentation
-- [x] 100% test coverage
-- [x] provide a portable Z85 implementation
-  * unlike [fpesce/z85](https://github.com/fpesce/z85), which is a C extension
-- [x] 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
 
 ### Class Hierarchy
@@ -96,51 +71,28 @@ More information in the [API documentation](http://www.rubydoc.info/github/paddo
   * use `Socket#CURVE_server!(cert)` on the server
   * and `Socket#CURVE_client!(client_cert, server_cert)` on the client
 * socket types as Ruby classes
-  * no need to manually pass some constant
+  * no need to manually pass type constants
     * but you can: `CZTop::Socket.new_by_type(:REP)`
-  * e.g. `#subscribe` only exists on CZTop::Socket::SUB
-* DRAFT API ready
-  * CLIENT/SERVER/RADIO/DISH/SCATTER/GATHER and other DRAFT methods are supported if the libraries (ZMQ/CZMQ) have been compiled with DRAFT APIs enabled (`--enable-drafts`)
-  * there is `#routing_id` and `#routing_id=` on the following classes:
-    * CZTop::Message
-    * CZTop::Frame
-  * there is `#group` and `#group=` on CZTop::Frame
-* ZMTP 3.1 heartbeat ready
-  * `socket.options.heartbeat_ivl = 2000`
-  * `socket.options.heartbeat_timeout = 8000`
+  * e.g. `#subscribe` only exists on `CZTop::Socket::SUB`
 
 ## Requirements
 
-You'll need:
-
-* CZMQ >= 4.0.0
-* ZMQ >= 4.2.0
 
-For security mechanisms like CURVE, it's recommended to use Libsodium. However,
-ZMQ can be compiled with tweetnacl enabled.
+* CZMQ >= 4.2
+* ZMQ >= 4.3
 
-To install on OSX using homebrew, run:
 
-    $ brew install libsodium
-    $ brew install zmq  --HEAD --with-libsodium
-    $ brew install czmq --HEAD
+On Ubuntu 20.04+:
 
-If you're running Linux, go check [this page](http://zeromq.org/distro:_start)
-to get more help. Make sure to install CZMQ, not only ZMQ.
+    $ sudo apt install libczmq-dev
 
-**Note:** Currently (as of May 2016), when compiling ZMQ from master, it may
-be required to pass `--enable-drafts` to `./configure` to make sure all the
-`zmq_poller_*()` functions are available. However, this doesn't seem to be the
-case on all systems.
+On macOS using Homebrew, run:
 
-### Supported Ruby versions
+    $ brew install czmq
 
-See [.travis.yml](https://github.com/paddor/cztop/blob/master/.travis.yml) for a list of Ruby versions against which CZTop
-is tested.
+### Supported Rubies
 
-At the time of writing, these include:
-
-* MRI (2.3, 2.2)
+* MRI (2.6, 2.7, 3.0)
 * Rubinius (HEAD)
 * JRuby 9000 (HEAD)
 
@@ -165,222 +117,21 @@ Or install it yourself as:
 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.
+CZTop is just a convenience layer on top of the thin czmq-ffi-gen library.
 
-Make sure you check out the
+Make sure to 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:
-
-### rep.rb:
-
-```ruby
-#!/usr/bin/env ruby
-require 'cztop'
-
-# create and bind socket
-socket = CZTop::Socket::REP.new("ipc:///tmp/req_rep_example")
-puts "<<< Socket bound to #{socket.last_endpoint.inspect}"
-
-# Simply echo every message, with every frame String#upcase'd.
-while msg = socket.receive
-  puts "<<< #{msg.to_a.inspect}"
-  socket << msg.to_a.map(&:upcase)
-end
-```
-
-### req.rb:
-
-```ruby
-#!/usr/bin/env ruby
-require 'cztop'
-
-# connect
-socket = CZTop::Socket::REQ.new("ipc:///tmp/req_rep_example")
-puts ">>> Socket connected."
-
-# simple string
-socket << "foobar"
-msg = socket.receive
-puts ">>> #{msg.to_a.inspect}"
-
-# multi frame message as array
-socket << %w[foo bar baz]
-msg = socket.receive
-puts ">>> #{msg.to_a.inspect}"
-
-# manually instantiating a Message
-msg = CZTop::Message.new("bla")
-msg << "another frame" # append a frame
-socket << msg
-msg = socket.receive
-puts ">>> #{msg.to_a.inspect}"
-
-##
-# This will send 20 additional messages:
-#
-#   $ ./req.rb 20
-#
-if ARGV.first
-  ARGV.first.to_i.times do
-    socket << ["fooooooooo", "baaaaaar"]
-    puts ">>> " + socket.receive.to_a.inspect
-  end
-end
-```
-
-### Running it
-
-```
-$ ./rep.rb & ./req.rb 3
-[3] 35321
->>> Socket connected.
-<<< Socket bound to "ipc:///tmp/req_rep_example"
-<<< ["foobar"]
->>> ["FOOBAR"]
-<<< ["foo", "bar", "baz"]
->>> ["FOO", "BAR", "BAZ"]
-<<< ["bla", "another frame"]
->>> ["BLA", "ANOTHER FRAME"]
-<<< ["fooooooooo", "baaaaaar"]
->>> ["FOOOOOOOOO", "BAAAAAAR"]
-<<< ["fooooooooo", "baaaaaar"]
->>> ["FOOOOOOOOO", "BAAAAAAR"]
-<<< ["fooooooooo", "baaaaaar"]
->>> ["FOOOOOOOOO", "BAAAAAAR"]
-$
-```
-
-## TODO
-
-* [x] pack generated code into its own gem ([czmq-ffi-gen](https://github.com/paddor/czmq-ffi-gen))
-* think of a neat Ruby API, including:
-  - [x] Actor
-  - [x] Beacon
-  - [x] Certificate
-  - [x] Socket
-    - [50%] access to all socket options
-    - [x] Security mechanisms
-  - [x] Message
-  - [x] Frame
-    - [x] enumerable Frames
-  - [x] Authenticator
-  - [x] Loop
-  - [x] Monitor
-  - [x] Poller
-  - [x] Proxy
-  - [x] Config
-  - [x] Z85
-* write the missing XML API files in CZMQ
-  - [x] zarmour.xml
-  - [x] zconfig.xml
-  - [x] zsock_option.xml
-  - [x] zcert.xml
-  - [x] zcertstore.xml
-* [x] check availability of libsodium within CZTop
-* [x] read error strings for exceptions where appropriate (zmq_strerror)
-* [x] add support for ZMTP 3.1 heartbeats in CZMQ
-* [x] add padded variant of Z85
-* add more examples
-  * [x] [simple REQ/REP](https://github.com/paddor/cztop/tree/master/examples/simple_req_rep)
-  * [x] [Taxy System](https://github.com/paddor/cztop/tree/master/examples/taxi_system) with CURVE security and heartbeating
-    * [x] change from ROUTER/DEALER to SERVER/CLIENT
-  * [x] [Actor](https://github.com/paddor/cztop/tree/master/examples/ruby_actor) with Ruby block
-  * [ ] PUSH/PULL
-  * [ ] PUB/SUB
-* [ ] add performance benchmarks
-  * [x] inproc latency
-  * [x] inproc throughput
-  * [x] local/remote latency
-  * [ ] local/remote throughput
-  * see [perf](https://github.com/paddor/cztop/blob/master/perf) directory
-* [x] support older versions of ZMQ
-  * [x] ZMQ HEAD
-    * [x] tested on CI
-  * [x] ZMQ 4.1
-    * [x] tested on CI
-    * as of April 2016, this isn't the case anymore
-  * [x] ZMQ 4.0
-    * [x] tested on CI
-    * as of March 2016, this isn't the case anymore
-  * [ ] ZMQ 3.2
-    * too big a pain ([d5172ab](https://github.com/paddor/czmq-ffi-gen/commit/d5172ab6db64999c50ba24f71569acf1dd45af51))
-* [x] support multiple versions of CZMQ
-  * [x] CZMQ HEAD
-    * [x] test on CI
-  * [x] CZMQ 3.0.2 (current stable)
-    * no `zcert_meta_unset()` ([zeromq/czmq#1246](https://github.com/zeromq/czmq/issues/1246))
-      * [x] adapt czmq-ffi-gen so it doesn't raise while `attach_function`
-    * no `zproc`(especially no `zproc_has_curve()`)
-      * [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
-    * as of March, 2016, this isn't the case anymore
-* [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
-  * could then be used in Celluloid::ZMQ
-* [ ] 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 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
-* [x] provide `z85encode` and `z85decode` utilities
-  * can be used in a pipeline (limited memory usage)
-  * reusable interface: `Z85::Pipe`
-
-## Reasons
-
-Why another CZMQ Ruby binding? Here is a list of existing projects I found and
-the issues with them, from my point of view:
-
-* [Asmod4n/ruby-ffi-czmq](https://github.com/Asmod4n/ruby-ffi-czmq)
-  * outdated
-  * according to its author, it's an "abomination"
-* [methodmissing/rbczmq](https://github.com/methodmissing/rbczmq)
-  * no support for security features (see [methodmissing/rbczmq#28](https://github.com/methodmissing/rbczmq/issues/28))
-  * no JRuby support (see [methodmissing/rbczmq#48](https://github.com/methodmissing/rbczmq/issues/48))
-  * doesn't feel like Ruby
-* [mtortonesi/ruby-czmq](https://github.com/mtortonesi/ruby-czmq)
-  * no tests
-  * no documentation
-  * outdated
-  * doesn't feel like Ruby
-* [chuckremes/ffi-rzmq](https://github.com/chuckremes/ffi-rzmq)
-  * support discontinued
-  * low level ZMQ gem, not CZMQ
-
-Furthermore, I knew about the generated low-level Ruby FFI binding in the
-[zeromq/czmq](https://github.com/zeromq/czmq) repository. I wanted to make use
-of it because I love that it's generated (and thus, most likely correct
-and up-to-date). Unfortunately, it was in pretty bad shape and missing a few
-CZMQ classes.
-
-So I decided to improve the quality and usability of the binding and add the
-missing classes. The result is
-[czmq-ffi-gen](https://github.com/paddor/czmq-ffi-gen) which provides a solid
-foundation for CZTop.
+See the [examples](https://github.com/paddor/cztop/blob/master/examples) directory for some examples.
 
 
 ## Contributing

data/cztop.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'cztop/version'
+# frozen_string_literal: true
+
+require_relative "lib/cztop/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "cztop"
@@ -9,28 +8,27 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Patrik Wenger"]
   spec.email         = ["paddor@gmail.com"]
 
-  spec.summary       = %q{CZMQ Ruby binding, based on the generated low-level FFI bindings of CZMQ}
-  spec.homepage      = "https://github.com/paddor/cztop"
+  spec.summary       = %q{CZMQ Ruby binding based on the generated low-level FFI bindings of CZMQ}
+  spec.homepage      = "https://rubygems.org/gems/cztop"
   spec.license       = "ISC"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/paddor/cztop"
+  spec.metadata["changelog_uri"]   = "https://github.com/paddor/cztop/blob/master/CHANGELOG.md"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "czmq-ffi-gen", "~> 0.13.0"
+  spec.add_runtime_dependency "czmq-ffi-gen", "~> 1.0"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "rspec-given", "~> 3.8.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "yard"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "guard-yard"
-  spec.add_development_dependency "guard-shell"
-  spec.add_development_dependency 'terminal-notifier-guard'
-  spec.add_development_dependency 'foreman'
 end

data/lib/cztop/certificate.rb

@@ -8,7 +8,7 @@ module CZTop
     # Warns if CURVE security isn't available.
     # @return [void]
     def self.check_curve_availability
-      return if Zproc.has_curve
+      return if Zsys.has_curve
       warn "CZTop: CURVE isn't available. Consider installing libsodium."
     end
 

data/lib/cztop/frame.rb

@@ -156,13 +156,13 @@ module CZTop
     end
 
     # Gets the group (radio/dish pattern).
-    # @note This only set when the frame has been read from
+    # @note This is only set when the frame has been read from
     #   a {CZTop::Socket::DISH} socket.
     # @return [String] the group
     # @return [nil] when no group has been set
     def group
       group = ffi_delegate.group
-      return nil if group.empty?
+      return nil if group.nil? || group.empty?
       group
     end
 
@@ -174,7 +174,7 @@ module CZTop
     # @return [new_group]
     def group=(new_group)
       rc = ffi_delegate.set_group(new_group)
-      raise_zmq_err("unable to set group to %p" % group) if rc == -1
+      raise_zmq_err("unable to set group to %p" % new_group) if rc == -1
     end
   end
 end

data/lib/cztop/message.rb

@@ -142,7 +142,16 @@ module CZTop
     #   strings. This can be a problem if the message is huge/has huge frames.
     # @return [Array<String>] all frames
     def to_a
-      frames.map(&:to_s)
+      ffi_delegate = ffi_delegate()
+      frame = ffi_delegate.first
+      return [] if frame.null?
+
+      arr = [ frame.data.read_bytes(frame.size) ]
+      while frame = ffi_delegate.next and not frame.null?
+        arr << frame.data.read_bytes(frame.size)
+      end
+
+      return arr
     end
 
     # Inspects this {Message}.

data/lib/cztop/monitor.rb

@@ -39,6 +39,7 @@ module CZTop
 
     # @return [Array<String>] types of valid events
     EVENTS = %w[
+      ALL
       CONNECTED
       CONNECT_DELAYED
       CONNECT_RETRIED
@@ -50,9 +51,10 @@ module CZTop
       CLOSE_FAILED
       DISCONNECTED
       MONITOR_STOPPED
-      HANDSHAKE_FAILED
-      HANDSHAKE_SUCCEED
-      ALL
+      HANDSHAKE_SUCCEEDED
+      HANDSHAKE_FAILED_NO_DETAIL
+      HANDSHAKE_FAILED_PROTOCOL
+      HANDSHAKE_FAILED_AUTH
     ]
 
     # Configure monitor to listen for specific events.
@@ -73,6 +75,18 @@ module CZTop
       @actor.wait
     end
 
+    # Useful for registration in an event-loop.
+    # @return [Integer] the FD
+    # @see ZsockOptions#fd
+    def fd
+      @actor.fd
+    end
+
+    # @return [Boolean] whether there's at least one event available
+    def readable?
+      @actor.readable?
+    end
+
     # Get next event. This blocks until the next event is available.
     # @example
     #   socket = CZTop::Socket::ROUTER.new("tcp://127.0.0.1:5050")
@@ -93,8 +107,8 @@ module CZTop
     #     end
     #   end
     #
-    # @return [String] one of the events from {EVENTS}, something like
-    #   <tt>["ACCEPTED", "73", "tcp://127.0.0.1:55585"]</tt>
+    # @return [Message] one of the events from (after {#to_a} it's something like
+    #   <tt>["ACCEPTED", "73", "tcp://127.0.0.1:55585"]</tt>)
     def next
       @actor.receive
     end

data/lib/cztop/poller/zmq.rb

@@ -9,8 +9,9 @@ module CZTop
 
     extend ::FFI::Library
     lib_name = 'libzmq'
-    lib_paths = ['/usr/local/lib', '/opt/local/lib', '/usr/lib64']
-      .map { |path| "#{path}/#{lib_name}.#{::FFI::Platform::LIBSUFFIX}" }
+    lib_dirs = ['/usr/local/lib', '/opt/local/lib', '/usr/lib64']
+    lib_dirs = [*ENV['LIBZMQ_PATH'].split(':'), *lib_dirs] if ENV['LIBZMQ_PATH']
+    lib_paths = lib_dirs.map { |path| "#{path}/#{lib_name}.#{::FFI::Platform::LIBSUFFIX}" }
     ffi_lib lib_paths + [lib_name]
 
     # This represents a +zmq_poller_event_t+ as in:

data/lib/cztop/version.rb

@@ -1,3 +1,3 @@
 module CZTop
-  VERSION = "0.12.1"
+  VERSION = "1.0.0"
 end

data/lib/cztop/zsock_options.rb

@@ -29,6 +29,13 @@ module CZTop
       (options.events & Poller::ZMQ::POLLOUT) > 0
     end
 
+    # Useful for registration in an event-loop.
+    # @return [Integer]
+    # @see OptionsAccessor#fd
+    def fd
+      options.fd
+    end
+
     # Used to access the options of a {Socket} or {Actor}.
     class OptionsAccessor
       # @return [Socket, Actor] whose options this {OptionsAccessor} instance
@@ -312,6 +319,20 @@ module CZTop
       # @see CZTop::Poller::ZMQ::POLLIN and CZTop::Poller::ZMQ::POLLOUT
       def events() Zsock.events(@zocket) end
 
+      # @return [Integer] current value of RECONNECT_IVL
+      def reconnect_ivl() Zsock.reconnect_ivl(@zocket) end
+      # This defines the number of milliseconds to wait while
+      # closing/disconnecting a socket if there are outstanding messages to
+      # send.
+      #
+      # Default is 0, which means to not wait at all. -1 means to wait
+      # indefinitely
+      #
+      # @param new_value [Integer] new value for RECONNECT_IVL
+      def reconnect_ivl=(new_value)
+        Zsock.set_reconnect_ivl(@zocket, new_value)
+      end
+
 # TODO: a reasonable subset of these
 #//  Get socket options
 #int zsock_gssapi_server (void *self);
@@ -325,7 +346,6 @@ module CZTop
 #int zsock_recovery_ivl (void *self);
 #int zsock_sndbuf (void *self);
 #int zsock_rcvbuf (void *self);
-#int zsock_reconnect_ivl (void *self);
 #int zsock_reconnect_ivl_max (void *self);
 #int zsock_backlog (void *self);
 #int zsock_maxmsgsize (void *self);
@@ -366,7 +386,6 @@ module CZTop
 #void zsock_set_recovery_ivl (void *self, int recovery_ivl);
 #void zsock_set_sndbuf (void *self, int sndbuf);
 #void zsock_set_rcvbuf (void *self, int rcvbuf);
-#void zsock_set_reconnect_ivl (void *self, int reconnect_ivl);
 #void zsock_set_reconnect_ivl_max (void *self, int reconnect_ivl_max);
 #void zsock_set_backlog (void *self, int backlog);
 #void zsock_set_maxmsgsize (void *self, int maxmsgsize);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cztop
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Patrik Wenger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-24 00:00:00.000000000 Z
+date: 2021-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: czmq-ffi-gen
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -122,90 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-shell
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: terminal-notifier-guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: foreman
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - paddor@gmail.com
@@ -215,21 +131,19 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".ruby-version"
 - ".yardopts"
 - AUTHORS
 - CHANGES.md
 - Gemfile
-- Guardfile
 - LICENSE
-- Procfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
-- ci-scripts/install-deps
 - cztop.gemspec
 - examples/ruby_actor/actor.rb
 - examples/simple_req_rep/rep.rb
@@ -283,10 +197,13 @@ files:
 - perf/inproc_thru.rb
 - perf/local_lat.rb
 - perf/remote_lat.rb
-homepage: https://github.com/paddor/cztop
+homepage: https://rubygems.org/gems/cztop
 licenses:
 - ISC
-metadata: {}
+metadata:
+  homepage_uri: https://rubygems.org/gems/cztop
+  source_code_uri: https://github.com/paddor/cztop
+  changelog_uri: https://github.com/paddor/cztop/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -295,16 +212,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.2.4
 signing_key: 
 specification_version: 4
-summary: CZMQ Ruby binding, based on the generated low-level FFI bindings of CZMQ
+summary: CZMQ Ruby binding based on the generated low-level FFI bindings of CZMQ
 test_files: []

data/.travis.yml

@@ -1,37 +0,0 @@
-language: ruby
-dist: trusty
-sudo: false
-cache:
-  directories:
-    - $HOME/.ccache
-    - $HOME/.bundle
-rvm:
-  - 2.4.2
-  - 2.3.5
-  - 2.2.8
-  - jruby-head
-  - rubinius-3.86
-env:
-  # NOTE: These are recognized by czmq-ffi-gen's CI scripts.
-  - CZMQ_VERSION=HEAD ZMQ_VERSION=HEAD
-  - CZMQ_VERSION=stable ZMQ_VERSION=stable
-matrix:
-  exclude:
-    - rvm: 2.3.5
-      env: CZMQ_VERSION=HEAD ZMQ_VERSION=HEAD
-    - rvm: 2.2.8
-      env: CZMQ_VERSION=HEAD ZMQ_VERSION=HEAD
-    - rvm: jruby-head
-      env: CZMQ_VERSION=HEAD ZMQ_VERSION=HEAD
-    - rvm: rubinius-3.86
-      env: CZMQ_VERSION=HEAD ZMQ_VERSION=HEAD
-  allow_failures:
-    - rvm: rubinius-3.86
-before_install:
-  - PATH="/usr/lib/ccache:$PATH" # enable ccache
-  - export LD_LIBRARY_PATH=$HOME/lib # custom libs (for execution)
-  - export PKG_CONFIG_PATH=$HOME/lib/pkgconfig # custom libs (for linking)
-  - export BUNDLE_PATH=$HOME/.bundle # bundle caching
-  - ci-scripts/install-deps
-  - gem install bundler -v 1.10.6
-script: bundle exec rake spec

data/Guardfile

@@ -1,61 +0,0 @@
-require "guard/rspec/dsl"
-
-# Start using
-#
-#   bundle exec guard -g doc & bundle exec guard -g spec
-#
-# This way you get parallel execution, so
-# * documentation is regenerated immediately
-# * specs are run immediately
-
-README_FILE = %r{^README\.md}
-
-# set these later using help from guard-rspec
-ruby_lib_files = nil
-spec_files     = nil
-
-# I don't need no shell that hogs my CPU whenever I hit return.
-interactor :off
-
-group :spec do
-  guard :rspec, cmd: "bundle exec rspec" do
-    dsl = Guard::RSpec::Dsl.new(self)
-
-    # RSpec files
-    rspec = dsl.rspec
-    watch(rspec.spec_helper) { rspec.spec_dir }
-    watch(rspec.spec_support) { rspec.spec_dir }
-    watch(rspec.spec_files)
-    spec_files = rspec.spec_files
-
-    # Ruby files
-    ruby = dsl.ruby
-    watch(ruby.lib_files) { |m| rspec.spec.(m[1]) }
-    ruby_lib_files = ruby.lib_files
-  end
-
-
-  puts "README pattern: %p" % README_FILE
-  puts "ruby lib files pattern: %p" % ruby_lib_files
-  puts "spec files pattern: %p" % spec_files
-end
-
-group :syntax_check do
-  guard :shell do
-    # check Ruby syntax
-    watch(Regexp.union(ruby_lib_files, spec_files)) do |m|
-      puts "Checking Ruby syntax of %p ..." % m[0]
-      if not system("ruby -c #{m[0]}")
-        n "#{m[0]} is incorrect", 'Ruby Syntax', :failed
-      end
-    end
-  end
-end
-
-YARD_OPTS = "--use-cache .yardoc/cache.db"
-
-group :doc do
-  guard 'yard' do
-    watch(Regexp.union(README_FILE, ruby_lib_files))
-  end
-end

data/Procfile

@@ -1,3 +0,0 @@
-doc: bundle exec guard -g doc
-spec: bundle exec guard -g spec
-syntax_check: bundle exec guard -g syntax_check

data/ci-scripts/install-deps

@@ -1,8 +0,0 @@
-#!/bin/sh -x
-set -e
-mkdir -p vendor
-cd vendor
-git clone --depth 1 https://github.com/paddor/czmq-ffi-gen
-cd czmq-ffi-gen
-ci-scripts/install-libzmq
-ci-scripts/install-libczmq