cztop 1.2.5 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f69946c755652d803136712eb37943759d0266b68c6cf7be08d87a70c3fa84c9
-  data.tar.gz: 7019a58ab3cfd1ad5670b7ae7a2af5eb27a50b19186e2a7c727de98121cab529
+  metadata.gz: ca8b5fa8bb96e24ab3c500b704891677ab4431b66f027cfd68dd15d7be79a380
+  data.tar.gz: c6360aaef9640bf4f7f75bf3f7f2229d48c93b9e5929bdb28c5012fb9a014806
 SHA512:
-  metadata.gz: 74c495a413b86d3dbefcea43701aca13f4f6c13640b206da210d0b9f3c132e29f93750908e73dc8b7929b37dca199fb99f4bd6dfd78083e155d84cfb12c1343d
-  data.tar.gz: fa73f38fc6923d6eb92272a55e00b3ac7bbad5d9031a101b93cdd83618cb3e2e301b0a68a029658800692bb1c35c905220b4af089c42db1dc65ff89c270b91fb
+  metadata.gz: b099c61bbfde6095eaf621b09f13501e2529f87fd91850863b4bdb30d4856584908fc06712371db6f767bf2061f9752cb26991b185e9dd8ab212d686911747fd
+  data.tar.gz: 0731e75df8e20bbfb12546ef2145811104dc117eb381b65edbe1733cf147b4785bcc96679a372f3029351da338872c915f7d801f7031f5302ad52196fec056a7

data/CHANGES.md

@@ -1,3 +1,14 @@
+1.2.6 (7/12/2024)
+-----
+* add missing `require 'io/wait'` to get `IO#wait_readable`
+* CZTop::Socket#wait_readable
+    - drop broken support for Ruby < 3.2
+    - work around quirks of edge-triggered ZMQ FD
+* CZTop::Socket#wait_writable
+    - drop broken support for Ruby < 3.2
+    - work around quirks of edge-triggered ZMQ FD
+    - fix waiting for readiness on ZMQ FD
+
 1.2.5 (7/11/2024)
 -----
 * CZTop::Socket::ROUTER#wait_writable: don't raise SocketError if no peer is connected

data/README.md

@@ -100,7 +100,7 @@ A slightly more complex version (more sockets) is [here](https://github.com/padd
 ### Features
 
 * Ruby idiomatic API
-* Fiber Scheduler aware
+* compatible with Fiber Scheduler (only on Ruby >= 3.2)
 * errors as exceptions
 * CURVE security
 * supports CZMQ DRAFT API

data/lib/cztop/send_receive_methods.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
+begin
+  require 'io/wait'
+rescue LoadError
+end
+
 unless defined? IO::TimeoutError
-  # Support Ruby < 3.2
+  # Define this to avoid NameError on Ruby < 3.2
   class IO::TimeoutError < IOError
   end
 end
@@ -42,6 +47,21 @@ module CZTop
     end
 
 
+    # Because ZMQ sockets are edge-triggered, there's a small chance that we miss an edge (race condition). To avoid
+    # blocking forever, all waiting on the ZMQ FD is done with this timeout.
+    FD_TIMEOUT = 0.5
+
+
+    # @note Only available on Ruby >= 3.2
+    #
+    def wait_for_fd_signal
+      @fd_io ||= to_io
+      @fd_io.wait_readable FD_TIMEOUT # NOTE: always wait for readability on ZMQ FD
+    end if IO.method_defined?(:wait_readable)
+
+
+    # Sometimes the ZMQ FD just insists on readiness. To avoid hogging the CPU, a sleep of this many seconds is
+    # included in the tight loop.
     JIFFY = 0.015 # 15 ms
 
 
@@ -49,72 +69,54 @@ module CZTop
     # @param timeout [Numeric, nil] timeout in seconds
     # @return [true] if readable within timeout
     # @raise [IO::EAGAINWaitReadable, IO::TimeoutError] if timeout has been reached
+    # @raise [CZMQ::FFI::Zsock::DestroyedError] if socket has already been destroyed
+    # @note Only available on Ruby >= 3.2
+    #
     def wait_readable(timeout = read_timeout)
       return true if readable?
 
-      @fd_io ||= to_io
+      timeout_at = now + timeout if timeout
 
-      if timeout
-        timeout_at = now + timeout
+      while true
+        # p wait_readable: self, timeout: timeout
 
-        while true
-          # p wait_readable: self, timeout: timeout
-          @fd_io.wait_readable(timeout)
-          break if readable? # NOTE: ZMQ FD can't be trusted
-          raise ::IO::TimeoutError if now >= timeout_at
+        wait_for_fd_signal
+        break if readable? # NOTE: ZMQ FD can't be trusted
+        raise ::IO::TimeoutError if timeout_at && now >= timeout_at
 
-          # HACK for edge case: avoid hogging CPU if FD for socket type doesn't block and just insists
-          sleep JIFFY
-        end
-      else
-        while true
-          # p wait_readable: self
-          @fd_io.wait_readable
-          break if readable? # NOTE: ZMQ FD can't be trusted
-
-          # HACK for edge case: avoid hogging CPU if FD for socket type doesn't block and just insists
-          sleep JIFFY
-        end
+        sleep JIFFY # HACK
+        break if readable? # NOTE: ZMQ FD is edge-triggered. Check again before blocking.
       end
 
       true
-    end
+    end if IO.method_defined?(:wait_readable)
 
 
     # Waits for socket to become writable.
     # @param timeout [Numeric, nil] timeout in seconds
     # @return [true] if writable within timeout
     # @raise [IO::EAGAINWaitReadable, IO::TimeoutError] if timeout has been reached
+    # @raise [CZMQ::FFI::Zsock::DestroyedError] if socket has already been destroyed
+    # @note Only available on Ruby >= 3.2
+    #
     def wait_writable(timeout = write_timeout)
       return true if writable?
 
-      @fd_io ||= to_io
+      timeout_at = now + timeout if timeout
 
-      if timeout
-        timeout_at = now + timeout
+      while true
+        # p wait_writable: self, timeout: timeout
 
-        while true
-          # p wait_writable: self, timeout: timeout
-          @fd_io.wait_writable(timeout)
-          break if writable? # NOTE: ZMQ FD can't be trusted
-          raise ::IO::TimeoutError if now >= timeout_at
+        wait_for_fd_signal
+        break if writable? # NOTE: ZMQ FD can't be trusted
+        raise ::IO::TimeoutError if timeout_at && now >= timeout_at
 
-          # HACK for edge case: avoid hogging CPU if FD for socket type doesn't block and just insists
-          sleep JIFFY
-        end
-      else
-        while true
-          # p wait_writable: self
-          @fd_io.wait_writable
-          break if writable? # NOTE: ZMQ FD can't be trusted
-
-          # HACK for edge case: avoid hogging CPU if FD for socket type doesn't block and just insists
-          sleep JIFFY
-        end
+        sleep JIFFY # HACK
+        break if writable? # NOTE: ZMQ FD is edge-triggered. Check again before blocking.
       end
 
       true
-    end
+    end if IO.method_defined?(:wait_readable)
 
 
     # @return [Float, nil] the timeout in seconds used by {IO#wait_readable}

data/lib/cztop/version.rb

@@ -2,6 +2,6 @@
 
 module CZTop
 
-  VERSION = '1.2.5'
+  VERSION = '1.2.6'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cztop
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.2.6
 platform: ruby
 authors:
 - Patrik Wenger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: czmq-ffi-gen