cztop 1.1.0.pre1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 149778ca201f323611fe23b4b1107c4cb4bde8ea7364bbe7370cea39daf5ab02
-  data.tar.gz: 195be179654f5b1c286f4859a012a093bed587f644306ee63642a7e300b261f6
+  metadata.gz: a73261e3bc3a15f8302b4e7eca58eb25393cfe301d9b755a7291bf35ef126674
+  data.tar.gz: 5d1f75990a28eba2460cfd61e5825492bcd66604bd7990dbcdf4a74db00c0e7e
 SHA512:
-  metadata.gz: c2a65ca5f02e39cfc9ca2695fefd6b02c0e898878041a662d0af1361235fa1ec091c4024d0a9d68b793173f191ce81350e21cc98b0a2320d3d6c9d9617f35d50
-  data.tar.gz: bae808f502e3f8b3ced7872d76a6377578bd37d332bf12ba96aaa126ea7571abbbfe363426c9578c30ecd6abbc126198e470d3d378de0bd0b1960384ab9d17b7
+  metadata.gz: 9ebe5b00e21a32e0b645f50a789a8818dddf31d4ed69a74c247b30b443e02cd4cdd05121f3cd2bc286c41e21e09bc6feb0b304fc245d9be6dbaf648e287c0bb8
+  data.tar.gz: cd3c05936f8ce4c0c8c6b8f3774d70bfaf1a7b85d9770e159fb0aed4ae0628f97e74bbaa76742b7518a06d257dd6c22504dc2285a827fcc36b5bb5f59bf51ac8

data/.github/workflows/draft_api.yml

@@ -4,14 +4,14 @@ on: [push,pull_request]
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 15
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.1
+        ruby-version: 3.3
     - name: Install ZMQ and CZMQ
       run: |
         export PKG_CONFIG_PATH=$HOME/lib/pkgconfig # custom libs (for linking)

data/.github/workflows/stable_api.yml

@@ -4,13 +4,14 @@ on: [push,pull_request]
 
 jobs:
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
         ruby:
-          - 2.7
           - 3.0
           - 3.1
+          - 3.2
+          - 3.3
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby ${{ matrix.ruby }}

data/README.md

@@ -18,7 +18,7 @@ Here's an overview of the core classes:
 
 * [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)
+  * [Authenticator](http://www.rubydoc.info/gems/cztop/CZTop/Authenticator)
   * [Beacon](http://www.rubydoc.info/gems/cztop/CZTop/Beacon)
   * [Certificate](http://www.rubydoc.info/gems/cztop/CZTop/Certificate)
   * [CertStore](http://www.rubydoc.info/gems/cztop/CZTop/CertStore)
@@ -59,6 +59,7 @@ More information in the [API documentation](http://www.rubydoc.info/github/paddo
 
 ### Features
 
+* compatible with [Async](https://github.com/socketry/async) / [Async::IO](https://github.com/socketry/async-io)
 * Ruby-like API
   * method names
     * sending a message via a socket is done with `Socket#<<`
@@ -94,7 +95,7 @@ On macOS using Homebrew, run:
 
 ### Supported Rubies
 
-* MRI (2.6, 2.7, 3.0)
+* MRI (3.0, 3.2, 3.3)
 * Rubinius (HEAD)
 * JRuby 9000 (HEAD)
 

data/cztop.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   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.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   spec.metadata["homepage_uri"]    = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/paddor/cztop"
@@ -32,4 +32,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "yard"
   spec.add_development_dependency "rubocop", "~> 1.36.0"
+  spec.add_development_dependency "async", ">= 2.0.1"
+  spec.add_development_dependency "async-io"
 end

data/examples/async/.gitignore

@@ -0,0 +1 @@
+/Gemfile.lock

data/examples/async/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'async'
+gem 'cztop', path: '../../'
+gem 'async-io'

data/examples/async/README.md

@@ -0,0 +1 @@
+Run: `bundle exec ./async.rb`

data/examples/async/async.rb

@@ -0,0 +1,40 @@
+#! /usr/bin/env ruby
+
+require 'cztop/async'
+
+Async do |task|
+  task.async do |t|
+    socket = CZTop::Socket::REP.new("ipc:///tmp/req_rep_example")
+
+    # Simply echo every message, with every frame String#upcase'd.
+    socket.options.rcvtimeo = 3
+    io = Async::IO.try_convert socket
+
+    msg = io.receive
+    puts "<<< #{msg.to_a.inspect}"
+    io << msg.to_a.map(&:upcase)
+
+    puts "REP done."
+  end
+
+  task.async do
+    socket = CZTop::Socket::REQ.new("ipc:///tmp/req_rep_example")
+    puts ">>> Socket connected."
+
+    io = Async::IO.try_convert socket
+    # sleep 5
+    io << "foobar"
+
+    socket.options.rcvtimeo = 3
+    msg = io.receive
+    puts ">>> #{msg.to_a.inspect}"
+    puts "REQ done."
+  end
+
+  task.async do
+    6.times do
+      sleep 0.5
+      puts "tick"
+    end
+  end
+end

data/lib/cztop/async.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'cztop'
+require 'async/io'
+
+module Async
+  module IO
+
+    # Wrapper for CZTop sockets.
+    #
+    # @example
+    #   Async do |task|
+    #     socket = CZTop::Socket::REP.new("ipc:///tmp/req_rep_example")
+    #     socket.options.rcvtimeo = 3
+    #     io = Async::IO.try_convert socket
+    #     msg = io.receive
+    #     io << msg.to_a.map(&:upcase)
+    #   end
+
+    class CZTopSocket < Generic
+      wraps ::CZTop::Socket::REQ
+      wraps ::CZTop::Socket::REP
+      wraps ::CZTop::Socket::PAIR
+      wraps ::CZTop::Socket::ROUTER
+      wraps ::CZTop::Socket::DEALER
+      wraps ::CZTop::Socket::PUSH
+      wraps ::CZTop::Socket::PULL
+      wraps ::CZTop::Socket::PUB
+      wraps ::CZTop::Socket::SUB
+      wraps ::CZTop::Socket::XPUB
+      wraps ::CZTop::Socket::XSUB
+
+
+      # @see {CZTop::SendReceiveMethods#receive}
+      def receive
+        wait_readable
+        @io.receive
+      end
+
+
+      # @see {CZTop::SendReceiveMethods#<<}
+      def <<(...)
+        wait_writable
+        @io.<<(...)
+      end
+
+
+      # Waits for socket to become readable.
+      def wait_readable(timeout = read_timeout)
+        @io_fd ||= ::IO.for_fd @io.fd, autoclose: false
+
+        if timeout
+          timeout_at = now + timeout
+
+          while true
+            @io_fd.wait_readable(timeout)
+            break if @io.readable?
+            raise ::IO::TimeoutError if now >= timeout_at
+          end
+        else
+          @io_fd.wait_readable until @io.readable?
+        end
+      end
+
+
+      # Waits for socket to become writable.
+      def wait_writable(timeout = write_timeout)
+        @io_fd ||= ::IO.for_fd @io.fd, autoclose: false
+
+        if timeout
+          timeout_at = now + timeout
+
+          while true
+            @io_fd.wait_writable(timeout)
+            break if @io.writable?
+            raise ::IO::TimeoutError if now >= timeout_at
+          end
+        else
+          @io_fd.wait_writable until @io.writable?
+        end
+      end
+
+
+      # @return [Float, nil] the timeout in seconds used by {IO#wait_readable}
+      def read_timeout
+        timeout = @io.options.rcvtimeo
+
+        if timeout <= 0
+          timeout = nil
+        else
+          timeout = timeout.to_f / 1000
+        end
+
+        timeout
+      end
+
+
+      # @return [Float, nil] the timeout in seconds used by {IO#wait_writable}
+      def write_timeout
+        timeout = @io.options.sndtimeo
+
+        if timeout <= 0
+          timeout = nil
+        else
+          timeout = timeout.to_f / 1000
+        end
+
+        timeout
+      end
+
+
+      private
+
+
+      def now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+  end
+end

data/lib/cztop/socket/types.rb

@@ -7,20 +7,24 @@ module CZTop
     #  for the zsock_new() function.
     module Types
 
-      PAIR   = 0
-      PUB    = 1
-      SUB    = 2
-      REQ    = 3
-      REP    = 4
-      DEALER = 5
-      ROUTER = 6
-      PULL   = 7
-      PUSH   = 8
-      XPUB   = 9
-      XSUB   = 10
-      STREAM = 11
-      SERVER = 12
-      CLIENT = 13
+      PAIR    = 0
+      PUB     = 1
+      SUB     = 2
+      REQ     = 3
+      REP     = 4
+      DEALER  = 5
+      ROUTER  = 6
+      PULL    = 7
+      PUSH    = 8
+      XPUB    = 9
+      XSUB    = 10
+      STREAM  = 11
+      SERVER  = 12
+      CLIENT  = 13
+      RADIO   = 14
+      DISH    = 15
+      GATHER  = 16
+      SCATTER = 17
 
     end
 

data/lib/cztop/version.rb

@@ -2,6 +2,6 @@
 
 module CZTop
 
-  VERSION = '1.1.0.pre1'
+  VERSION = '1.1.0'
 
 end

data/lib/cztop/zsock_options.rb

@@ -264,29 +264,33 @@ module CZTop
 
       # @!group Send and Receive Timeouts
 
-      # @return [Integer] the timeout when receiving a message
+      # @return [Integer] the timeout in milliseconds when receiving a message
       # @see Message.receive_from
+      # @note -1 means infinite, 0 means nonblocking
       def rcvtimeo
         Zsock.rcvtimeo(@zocket)
       end
 
 
-      # @param timeout [Integer] new timeout
+      # @param timeout [Integer] new timeout in milliseconds
       # @see Message.receive_from
+      # @note -1 means infinite, 0 means nonblocking
       def rcvtimeo=(timeout)
         Zsock.set_rcvtimeo(@zocket, timeout)
       end
 
 
-      # @return [Integer] the timeout when sending a message
+      # @return [Integer] the timeout in milliseconds when sending a message
       # @see Message#send_to
+      # @note -1 means infinite, 0 means nonblocking
       def sndtimeo
         Zsock.sndtimeo(@zocket)
       end
 
 
-      # @param timeout [Integer] new timeout
+      # @param timeout [Integer] new timeout in milliseconds
       # @see Message#send_to
+      # @note -1 means infinite, 0 means nonblocking
       def sndtimeo=(timeout)
         Zsock.set_sndtimeo(@zocket, timeout)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cztop
 version: !ruby/object:Gem::Version
-  version: 1.1.0.pre1
+  version: 1.1.0
 platform: ruby
 authors:
 - Patrik Wenger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-18 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: czmq-ffi-gen
@@ -136,6 +136,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.36.0
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: async-io
+  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
@@ -163,6 +191,10 @@ files:
 - ci/install-libczmq
 - ci/install-libzmq
 - cztop.gemspec
+- examples/async/.gitignore
+- examples/async/Gemfile
+- examples/async/README.md
+- examples/async/async.rb
 - examples/ruby_actor/actor.rb
 - examples/simple_req_rep/rep.rb
 - examples/simple_req_rep/req.rb
@@ -181,6 +213,7 @@ files:
 - exe/z85encode
 - lib/cztop.rb
 - lib/cztop/actor.rb
+- lib/cztop/async.rb
 - lib/cztop/authenticator.rb
 - lib/cztop/beacon.rb
 - lib/cztop/cert_store.rb
@@ -230,14 +263,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: CZMQ Ruby binding based on the generated low-level FFI bindings of CZMQ