cztop 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 066d9600730db24e49b9b83fee30840882432df13dde7372f9e7f969b3774b33
-  data.tar.gz: 67ee0941443c6a9eadf7d27b4bc084e00d20c2dc7ca4448fc6459edc93a88efb
+  metadata.gz: 3f398a80bc75445bfd115544ca7f3e4c9f894cd1b9d58a9f0e2a90f6c0841275
+  data.tar.gz: 4d6b4c393b573c8bd64f4a65317bd6bbf258c5c2a7137ecabc681be6713c6f6a
 SHA512:
-  metadata.gz: c8852f4b214935ef5b0302a7a6481a2f51148dfc6fac939ca9d9b5f665ab06d8242418bdbe996edb9ad6fe010a84a540fd9b24e379cdd5b3197fd3c7a80f0478
-  data.tar.gz: 506f6e6b9a927e8c68d60c410d3ed84abfae1edef435c43baae8855eb2f02409815692eb4cf18501298ab5c8f9c988cdd48d308a93eb20d1ae136bf51c8283fe
+  metadata.gz: 12567ad2f7cadeb6067edcf61fb3ba975635d236edd4a5dd5465b6dcb931cf7c8b4f5852892c5bd4c0c5f0aaa87488f21b7ccb81a73a5d4134928b55f276ce4a
+  data.tar.gz: 99d6274e17d86865e80328184825f525f2959dbe926e052c9af88423f40e0fbf6f53531ef5de8eb22225315f2629e3580fd34f094031c21bbb37a665946d58b7

data/CHANGES.md

@@ -1,3 +1,8 @@
+1.1.2 (1/5/2024)
+-----
+* refactor to make code Fiber Scheduler agnostic
+* remove Async::IO::CZTopSocket
+
 1.1.1 (1/4/2024)
 -----
 * speed up Async::IO#wait_readable and #wait_writable

data/README.md

@@ -13,22 +13,22 @@ mechanisms (like CURVE).
 
 ## Example with Async
 
+See [this example](https://github.com/paddor/cztop/blob/master/examples/async.rb):
+
 ```ruby
 #! /usr/bin/env ruby
 
-require 'cztop/async'
+require 'cztop'
 
 Async do |task|
   task.async do |t|
     socket = CZTop::Socket::REP.new("inproc://req_rep_example")
-    io     = Async::IO.try_convert socket
-
     socket.options.rcvtimeo = 50 # ms
 
     loop do
-      msg = io.receive
+      msg = socket.receive
       puts "<<< #{msg.to_a.inspect}"
-      io << msg.to_a.map(&:upcase)
+      socket << msg.to_a.map(&:upcase)
     rescue IO::TimeoutError
       break
     end
@@ -38,11 +38,10 @@ Async do |task|
 
   task.async do
     socket = CZTop::Socket::REQ.new("inproc://req_rep_example")
-    io     = Async::IO.try_convert socket
 
     10.times do |i|
-      io << "foobar ##{i}"
-      msg = io.receive
+      socket << "foobar ##{i}"
+      msg = socket.receive
       puts ">>> #{msg.to_a.inspect}"
     end
 
@@ -54,6 +53,8 @@ end
 
 Output:
 ```
+$ cd examples
+$ time ./async.rb
 <<< ["foobar #0"]
 >>> ["FOOBAR #0"]
 <<< ["foobar #1"]
@@ -76,61 +77,20 @@ Output:
 >>> ["FOOBAR #9"]
 REQ done.
 REP done.
-0.46user 0.09system 0:00.60elapsed 90%CPU (0avgtext+0avgdata 47296maxresident)k
-0inputs+0outputs (0major+13669minor)pagefaults 0swaps
-```
-
-## Overview
-
-### Class Hierarchy
 
-Here's an overview of the core classes:
+________________________________________________________
+Executed in  401.51 millis    fish           external
+   usr time  308.44 millis  605.00 micros  307.83 millis
+   sys time   40.08 millis  278.00 micros   39.81 millis
 
-* [CZTop](http://www.rubydoc.info/gems/cztop/CZTop)
-  * [Actor](http://www.rubydoc.info/gems/cztop/CZTop)
-  * [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)
-  * [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)
-  * [Metadata](http://www.rubydoc.info/gems/cztop/CZTop/Metadata)
-  * [Proxy](http://www.rubydoc.info/gems/cztop/CZTop/Proxy)
-  * [Poller](http://www.rubydoc.info/gems/cztop/CZTop/Poller) (based on `zmq_poller_*()` functions)
-    * [Aggregated](http://www.rubydoc.info/gems/cztop/CZTop/Poller/Aggregated)
-    * [ZPoller](http://www.rubydoc.info/gems/cztop/CZTop/Poller/ZPoller)
-  * [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
-    * [RADIO](http://www.rubydoc.info/gems/cztop/CZTop/Socket/RADIO) < Socket
-    * [DISH](http://www.rubydoc.info/gems/cztop/CZTop/Socket/DISH) < Socket
-    * [SCATTER](http://www.rubydoc.info/gems/cztop/CZTop/Socket/SCATTER) < Socket
-    * [GATHER](http://www.rubydoc.info/gems/cztop/CZTop/Socket/GATHER) < Socket
-  * [Z85](http://www.rubydoc.info/gems/cztop/CZTop/Z85)
-    * [Padded](http://www.rubydoc.info/gems/cztop/CZTop/Z85/Padded) < Z85
-    * [Pipe](http://www.rubydoc.info/gems/cztop/CZTop/Z85/Pipe)
-  * [ZAP](http://www.rubydoc.info/gems/cztop/CZTop/ZAP)
+```
 
-More information in the [API documentation](http://www.rubydoc.info/github/paddor/cztop).
+## Overview
 
 ### Features
 
 * Ruby idiomatic API
-* compatible with [Async](https://github.com/socketry/async) / [Async::IO](https://github.com/socketry/async-io)
+* Fiber Scheduler aware
 * errors as exceptions
 * CURVE security
 * supports CZMQ DRAFT API
@@ -175,6 +135,51 @@ Or install it yourself as:
 
     $ gem install cztop
 
+### Class Hierarchy
+
+Here's an overview of the core classes:
+
+* [CZTop](http://www.rubydoc.info/gems/cztop/CZTop)
+  * [Actor](http://www.rubydoc.info/gems/cztop/CZTop)
+  * [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)
+  * [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)
+  * [Metadata](http://www.rubydoc.info/gems/cztop/CZTop/Metadata)
+  * [Proxy](http://www.rubydoc.info/gems/cztop/CZTop/Proxy)
+  * [Poller](http://www.rubydoc.info/gems/cztop/CZTop/Poller) (based on `zmq_poller_*()` functions)
+    * [Aggregated](http://www.rubydoc.info/gems/cztop/CZTop/Poller/Aggregated)
+    * [ZPoller](http://www.rubydoc.info/gems/cztop/CZTop/Poller/ZPoller)
+  * [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
+    * [RADIO](http://www.rubydoc.info/gems/cztop/CZTop/Socket/RADIO) < Socket
+    * [DISH](http://www.rubydoc.info/gems/cztop/CZTop/Socket/DISH) < Socket
+    * [SCATTER](http://www.rubydoc.info/gems/cztop/CZTop/Socket/SCATTER) < Socket
+    * [GATHER](http://www.rubydoc.info/gems/cztop/CZTop/Socket/GATHER) < Socket
+  * [Z85](http://www.rubydoc.info/gems/cztop/CZTop/Z85)
+    * [Padded](http://www.rubydoc.info/gems/cztop/CZTop/Z85/Padded) < Z85
+    * [Pipe](http://www.rubydoc.info/gems/cztop/CZTop/Z85/Pipe)
+  * [ZAP](http://www.rubydoc.info/gems/cztop/CZTop/ZAP)
+
+More information in the [API documentation](http://www.rubydoc.info/github/paddor/cztop).
+
 ## Documentation
 
 The API should be fairly straight-forward to anyone who is familiar with CZMQ

data/cztop.gemspec

@@ -36,6 +36,5 @@ Gem::Specification.new do |spec|
 
   if RUBY_VERSION >= '3.1'
     spec.add_development_dependency "async", ">= 2.0.1"
-    spec.add_development_dependency "async-io"
   end
 end

data/lib/cztop/message.rb

@@ -61,6 +61,8 @@ module CZTop
     #   returns with failure. Please report as bug.
     #
     def send_to(destination)
+      destination.wait_writable if Fiber.scheduler
+
       rc = Zmsg.send(ffi_delegate, destination)
       return if rc.zero?
 
@@ -79,6 +81,8 @@ module CZTop
     # @raise [SystemCallError] for any other error code set after +zmsg_recv+
     #   returns with failure. Please report as bug.
     def self.receive_from(source)
+      source.wait_readable if Fiber.scheduler
+
       delegate = Zmsg.recv(source)
       return from_ffi_delegate(delegate) unless delegate.null?
 

data/lib/cztop/send_receive_methods.rb

@@ -35,5 +35,80 @@ module CZTop
       Message.receive_from(self)
     end
 
+
+    # Waits for socket to become readable.
+    def wait_readable(timeout = read_timeout)
+      return true if readable?
+
+      @fd_io ||= to_io
+
+      if timeout
+        timeout_at = now + timeout
+
+        while true
+          @fd_io.wait_readable(timeout)
+          break if readable? # NOTE: ZMQ FD can't be trusted 100%
+          raise ::IO::TimeoutError if now >= timeout_at
+        end
+      else
+        @fd_io.wait_readable until readable?
+      end
+    end
+
+
+    # Waits for socket to become writable.
+    def wait_writable(timeout = write_timeout)
+      return true if writable?
+
+      @fd_io ||= to_io
+
+      if timeout
+        timeout_at = now + timeout
+
+        while true
+          @fd_io.wait_writable(timeout)
+          break if writable? # NOTE: ZMQ FD can't be trusted 100%
+          raise ::IO::TimeoutError if now >= timeout_at
+        end
+      else
+        @fd_io.wait_writable until writable?
+      end
+    end
+
+
+    # @return [Float, nil] the timeout in seconds used by {IO#wait_readable}
+    def read_timeout
+      timeout = 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 = 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

data/lib/cztop/version.rb

@@ -2,6 +2,6 @@
 
 module CZTop
 
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 
 end

data/lib/cztop/zsock_options.rb

@@ -43,6 +43,12 @@ module CZTop
     end
 
 
+    # @return [IO] IO for FD
+    def to_io
+      IO.for_fd fd, autoclose: false
+    end
+
+
     # Used to access the options of a {Socket} or {Actor}.
     class OptionsAccessor
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cztop
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Patrik Wenger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-04 00:00:00.000000000 Z
+date: 2024-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: czmq-ffi-gen
@@ -150,20 +150,6 @@ dependencies:
     - - ">="
       - !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: CZMQ binding based on the generated low-level FFI bindings of CZMQ
 email:
 - paddor@gmail.com
@@ -192,10 +178,6 @@ 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
@@ -214,7 +196,6 @@ 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

data/examples/async/.gitignore

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

data/examples/async/Gemfile

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

data/examples/async/README.md

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

data/examples/async/async.rb

@@ -1,35 +0,0 @@
-#! /usr/bin/env ruby
-
-require 'cztop/async'
-
-Async do |task|
-  task.async do |t|
-    socket = CZTop::Socket::REP.new("inproc://req_rep_example")
-    io     = Async::IO.try_convert socket
-
-    socket.options.rcvtimeo = 50 # ms
-
-    loop do
-      msg = io.receive
-      puts "<<< #{msg.to_a.inspect}"
-      io << msg.to_a.map(&:upcase)
-    rescue IO::TimeoutError
-      break
-    end
-
-    puts "REP done."
-  end
-
-  task.async do
-    socket = CZTop::Socket::REQ.new("inproc://req_rep_example")
-    io     = Async::IO.try_convert socket
-
-    10.times do |i|
-      io << "foobar ##{i}"
-      msg = io.receive
-      puts ">>> #{msg.to_a.inspect}"
-    end
-
-    puts "REQ done."
-  end
-end

data/lib/cztop/async.rb

@@ -1,124 +0,0 @@
-# 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
-
-        return true if @io.readable?
-
-        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
-
-        return true if @io.writable?
-
-        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