cztop 2.0.0.rc1 → 2.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de1d34e78550eaaaa2397a9bc1d1a29a57e36ef00d573a30e68b3903f8e1e43c
-  data.tar.gz: a9e4522e743b7dae26358acdcfb003fe12a15d5357654b6e32909c7e7ad5bf34
+  metadata.gz: 3381b5cf1edd7c878bb5c26ccc16bf096a354cfab0724a8da61e7f4ce3146272
+  data.tar.gz: c6081e0b22ee66190b3d34eb9d4d6a2d5ecfda537e8cdbfc223cfd23d2b56e9f
 SHA512:
-  metadata.gz: b81a176e6020b002abd3425bc66781e5eb7fdf3d907649139ffacfc7e7b1b12a17498e769dbb90fb13c29bbfe8d5d44ef8d73fa4446bb80613f9aaf159ca0eff
-  data.tar.gz: ebd44ce64395ddf965682392f7c719bc94fc4ae4277da5340c35b7cd2f9bf8c0206cb92f29fb2350ba6804de244b1c1d3df37d2359c4f391210bfb0e3626688f
+  metadata.gz: 8142a5ff3b45d88a3ebfc35b3a002dfb8b9be5937f0c37e1779530229d959b0457a1dfd49c062550b2c46d9389e5c3937272e979e5b703d09f68ed4732925201
+  data.tar.gz: 8591012e556649e6397c16a871f8f892a8b111ec06339e3271d03fd5eca187268363258429a949eb1d03c8245907cfbf30ae00662d9168f47e28aea14592094f

data/CHANGES.md

@@ -1,3 +1,14 @@
+2.0.0.rc2
+-----
+
+### Breaking changes
+
+* **Removed `Socket.new_by_type` factory method** — use type-specific constructors
+  instead (e.g. `Socket::REQ.new`, `Socket::PUB.new`)
+* **`linger` now defaults to 0** on all socket constructors — ZMQ's default of
+  infinite (-1) caused `#close` to block when unsent messages remained. Pass
+  `linger:` to override (e.g. `Socket::REQ.new(endpoint, linger: 1)`)
+
 2.0.0.rc1
 -----
 

data/README.md

@@ -37,6 +37,10 @@ gem install cztop
 gem 'cztop'
 ```
 
+## Learning ZeroMQ
+
+New to ZeroMQ? See [ZGUIDE_SUMMARY.md](ZGUIDE_SUMMARY.md) — a ~30 min read covering all major patterns with working CZTop code examples.
+
 ## Quick Start
 
 ### Request / Reply

data/ZGUIDE_SUMMARY.md

@@ -538,12 +538,10 @@ connecting (identity, HWM). Timeouts and linger can change at any time.
 sock = Cztop::Socket::REQ.new
 sock.send_timeout = 1          # 1 second
 sock.recv_timeout = 1          # 1 second
-sock.linger = 0                # drop unsent on close
 sock.identity = 'worker-1'    # ROUTER-visible identity
 
 # nil = no timeout / wait indefinitely:
 sock.send_timeout = nil
-sock.linger = nil
 ```
 
 Key options:
@@ -591,7 +589,7 @@ with it directly. Key rules:
 
 - Sockets are **not thread-safe** — one socket per thread
 - One I/O thread handles ~1 Gbps — usually enough
-- Set `linger = 0` for instant shutdown
+- `linger` defaults to `0` — instant shutdown, no blocking on close
 
 ---
 
@@ -667,7 +665,6 @@ def lazy_pirate_request(endpoint, request)
   MAX_RETRIES.times do |attempt|
     req = Cztop::Socket::REQ.connect(endpoint)
     req.recv_timeout = 2.5
-    req.linger = 0
 
     req << request
     begin
@@ -988,11 +985,11 @@ it and create a new one (Lazy Pirate).
 Not thread-safe. Silent data corruption, hangs, or segfaults. One
 socket per thread. Use `inproc://` between threads.
 
-### 3. Forgetting linger
+### 3. Overriding linger without resetting it
 
-CZTop defaults to `linger = 0`. If you changed it, `#close` blocks
-until queued messages are delivered. Always `socket.linger = 0` for
-sockets you want to close fast.
+CZTop defaults to `linger = 0` (drop unsent messages on close). If you
+set `linger = nil` (wait forever), remember to reset it before closing
+or `#close` will block until all queued messages are delivered.
 
 ### 4. Not setting timeouts
 
@@ -1065,7 +1062,8 @@ Peer-to-peer               ROUTER ──▶ ROUTER  (hard mode)
    until it isn't.
 2. **Don't share sockets across threads.** One socket per thread,
    `inproc://` between them.
-3. **Always set `linger`** — `sock.linger = 0` for clean shutdown.
+3. **`linger` defaults to 0** — sockets close instantly. Override with
+   `linger:` kwarg or `sock.linger =` only when you need delivery guarantees.
 4. **PUB/SUB filtering is prefix-based.** `""` = everything.
 5. **Connect from the ephemeral side.** Stable address binds.
 6. **Heartbeat everything** in production.

data/cztop.gemspec

@@ -19,8 +19,6 @@ Gem::Specification.new do |spec|
   spec.metadata["changelog_uri"]   = "https://github.com/paddor/cztop/blob/master/CHANGES.md"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match?(%r{^(\.|Rakefile|test/|examples/|bench/)}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "ffi"

data/lib/cztop/socket/dealer.rb

@@ -13,11 +13,13 @@ module CZTop
 
       # @param endpoints [String] endpoints to connect to
       # @param curve [Hash, nil] CURVE encryption options
+      # @param linger [Integer] linger period in milliseconds (default: 0)
       #
-      def initialize(endpoints = nil, curve: nil)
+      def initialize(endpoints = nil, curve: nil, linger: 0)
         super
 
         attach_ffi_delegate(Zsock.new(Types::DEALER))
+        self.linger = linger
         _apply_curve(curve)
         _attach(endpoints, default: :connect)
       end

data/lib/cztop/socket/pair.rb

@@ -13,11 +13,13 @@ module CZTop
 
       # @param endpoints [String] endpoints to connect to
       # @param curve [Hash, nil] CURVE encryption options
+      # @param linger [Integer] linger period in milliseconds (default: 0)
       #
-      def initialize(endpoints = nil, curve: nil)
+      def initialize(endpoints = nil, curve: nil, linger: 0)
         super
 
         attach_ffi_delegate(Zsock.new(Types::PAIR))
+        self.linger = linger
         _apply_curve(curve)
         _attach(endpoints, default: :connect)
       end

data/lib/cztop/socket/pub.rb

@@ -12,11 +12,13 @@ module CZTop
 
       # @param endpoints [String] endpoints to bind to
       # @param curve [Hash, nil] CURVE encryption options
+      # @param linger [Integer] linger period in milliseconds (default: 0)
       #
-      def initialize(endpoints = nil, curve: nil)
+      def initialize(endpoints = nil, curve: nil, linger: 0)
         super
 
         attach_ffi_delegate(Zsock.new(Types::PUB))
+        self.linger = linger
         _apply_curve(curve)
         _attach(endpoints, default: :bind)
       end

data/lib/cztop/socket/pull.rb

@@ -12,11 +12,13 @@ module CZTop
 
       # @param endpoints [String] endpoints to bind to
       # @param curve [Hash, nil] CURVE encryption options
+      # @param linger [Integer] linger period in milliseconds (default: 0)
       #
-      def initialize(endpoints = nil, curve: nil)
+      def initialize(endpoints = nil, curve: nil, linger: 0)
         super
 
         attach_ffi_delegate(Zsock.new(Types::PULL))
+        self.linger = linger
         _apply_curve(curve)
         _attach(endpoints, default: :bind)
       end

data/lib/cztop/socket/push.rb

@@ -12,11 +12,13 @@ module CZTop
 
       # @param endpoints [String] endpoints to connect to
       # @param curve [Hash, nil] CURVE encryption options
+      # @param linger [Integer] linger period in milliseconds (default: 0)
       #
-      def initialize(endpoints = nil, curve: nil)
+      def initialize(endpoints = nil, curve: nil, linger: 0)
         super
 
         attach_ffi_delegate(Zsock.new(Types::PUSH))
+        self.linger = linger
         _apply_curve(curve)
         _attach(endpoints, default: :connect)
       end

data/lib/cztop/socket/rep.rb

@@ -13,11 +13,13 @@ module CZTop
 
       # @param endpoints [String] endpoints to bind to
       # @param curve [Hash, nil] CURVE encryption options
+      # @param linger [Integer] linger period in milliseconds (default: 0)
       #
-      def initialize(endpoints = nil, curve: nil)
+      def initialize(endpoints = nil, curve: nil, linger: 0)
         super
 
         attach_ffi_delegate(Zsock.new(Types::REP))
+        self.linger = linger
         _apply_curve(curve)
         _attach(endpoints, default: :bind)
       end

data/lib/cztop/socket/req.rb

@@ -13,11 +13,13 @@ module CZTop
 
       # @param endpoints [String] endpoints to connect to
       # @param curve [Hash, nil] CURVE encryption options
+      # @param linger [Integer] linger period in milliseconds (default: 0)
       #
-      def initialize(endpoints = nil, curve: nil)
+      def initialize(endpoints = nil, curve: nil, linger: 0)
         super
 
         attach_ffi_delegate(Zsock.new(Types::REQ))
+        self.linger = linger
         _apply_curve(curve)
         _attach(endpoints, default: :connect)
       end

data/lib/cztop/socket/router.rb

@@ -13,11 +13,13 @@ module CZTop
 
       # @param endpoints [String] endpoints to bind to
       # @param curve [Hash, nil] CURVE encryption options
+      # @param linger [Integer] linger period in milliseconds (default: 0)
       #
-      def initialize(endpoints = nil, curve: nil)
+      def initialize(endpoints = nil, curve: nil, linger: 0)
         super
 
         attach_ffi_delegate(Zsock.new(Types::ROUTER))
+        self.linger = linger
         _apply_curve(curve)
         _attach(endpoints, default: :bind)
       end

data/lib/cztop/socket/stream.rb

@@ -14,11 +14,13 @@ module CZTop
 
       # @param endpoints [String] endpoints to connect to
       # @param curve [Hash, nil] CURVE encryption options
+      # @param linger [Integer] linger period in milliseconds (default: 0)
       #
-      def initialize(endpoints = nil, curve: nil)
+      def initialize(endpoints = nil, curve: nil, linger: 0)
         super
 
         attach_ffi_delegate(Zsock.new(Types::STREAM))
+        self.linger = linger
         _apply_curve(curve)
         _attach(endpoints, default: :connect)
       end

data/lib/cztop/socket/sub.rb

@@ -17,11 +17,13 @@ module CZTop
       # @param prefix [String, nil] subscription prefix; defaults to
       #   everything ({EVERYTHING}). Pass +nil+ to skip subscribing.
       # @param curve [Hash, nil] CURVE encryption options
+      # @param linger [Integer] linger period in milliseconds (default: 0)
       #
-      def initialize(endpoints = nil, prefix: EVERYTHING, curve: nil)
-        super(endpoints, curve: curve)
+      def initialize(endpoints = nil, prefix: EVERYTHING, curve: nil, linger: 0)
+        super(endpoints, curve: curve, linger: linger)
 
         attach_ffi_delegate(Zsock.new(Types::SUB))
+        self.linger = linger
         _apply_curve(curve)
         subscribe(prefix) unless prefix.nil?
         _attach(endpoints, default: :connect)

data/lib/cztop/socket/xpub.rb

@@ -13,11 +13,13 @@ module CZTop
 
       # @param endpoints [String] endpoints to bind to
       # @param curve [Hash, nil] CURVE encryption options
+      # @param linger [Integer] linger period in milliseconds (default: 0)
       #
-      def initialize(endpoints = nil, curve: nil)
+      def initialize(endpoints = nil, curve: nil, linger: 0)
         super
 
         attach_ffi_delegate(Zsock.new(Types::XPUB))
+        self.linger = linger
         _apply_curve(curve)
         _attach(endpoints, default: :bind)
       end

data/lib/cztop/socket/xsub.rb

@@ -13,11 +13,13 @@ module CZTop
 
       # @param endpoints [String] endpoints to connect to
       # @param curve [Hash, nil] CURVE encryption options
+      # @param linger [Integer] linger period in milliseconds (default: 0)
       #
-      def initialize(endpoints = nil, curve: nil)
+      def initialize(endpoints = nil, curve: nil, linger: 0)
         super
 
         attach_ffi_delegate(Zsock.new(Types::XSUB))
+        self.linger = linger
         _apply_curve(curve)
         _attach(endpoints, default: :connect)
       end

data/lib/cztop/socket.rb

@@ -33,33 +33,7 @@ module CZTop
     end
 
 
-    # @param type [Symbol, Integer] type from {Types} or like +:PUB+
-    # @return [REQ, REP, PUSH, PULL, ... ] the new socket
-    # @see Types
-    # @example Creating a socket by providing its type as a parameter
-    #   my_sock = CZTop::Socket.new_by_type(:DEALER, "tcp://example.com:4000")
-    #
-    def self.new_by_type(type)
-      case type
-      when Integer
-        type_code  = type
-        type_name  = TypeNames[type_code] or
-          raise ArgumentError, format('invalid type %p', type)
-        type_class = Socket.const_get(type_name)
-      when Symbol
-        type_code  = Types.const_get(type)
-        type_class = Socket.const_get(type)
-      else
-        raise ArgumentError, format('invalid socket type: %p', type)
-      end
-      ffi_delegate = Zsock.new(type_code)
-      sock         = type_class.allocate
-      sock.attach_ffi_delegate(ffi_delegate)
-      sock
-    end
-
-
-    def initialize(endpoints = nil, curve: nil); end
+    def initialize(endpoints = nil, curve: nil, linger: 0); end
 
 
     # @return [String] last bound endpoint, if any

data/lib/cztop/version.rb

@@ -2,6 +2,6 @@
 
 module CZTop
 
-  VERSION = '2.0.0.rc1'
+  VERSION = '2.0.0.rc2'
 
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: cztop
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc1
+  version: 2.0.0.rc2
 platform: ruby
 authors:
 - Patrik Wenger
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -139,9 +139,7 @@ description: CZMQ binding with hardcoded FFI bindings, providing a Ruby-like API
   ZMQ sockets
 email:
 - paddor@gmail.com
-executables:
-- z85decode
-- z85encode
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -153,11 +151,7 @@ files:
 - LICENSE
 - README.md
 - ZGUIDE_SUMMARY.md
-- bin/console
-- bin/setup
 - cztop.gemspec
-- exe/z85decode
-- exe/z85encode
 - lib/cztop.rb
 - lib/cztop/curve.rb
 - lib/cztop/curve/auth.rb

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "cztop"
-
-require "pry"
-Pry.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/exe/z85decode

@@ -1,31 +0,0 @@
-#!/usr/bin/env ruby
-require 'cztop'
-require 'optparse'
-require 'benchmark'
-
-options = { strategy: CZTop::Z85::Pipe::Strategy::Sequential }
-OptionParser.new do |opts|
-  opts.banner = "Usage: #$0 [options]"
-
-  opts.on("-p", "--parallel", "read, decode, and write in parallel " +
-                              "using 3 threads") do
-    options[:strategy] = CZTop::Z85::Pipe::Strategy::Parallel
-  end
-  opts.on("-v", "--verbose", "print some statistics afterwards") do
-    options[:verbose] = true
-  end
-end.parse!
-
-pipe = CZTop::Z85::Pipe.new(STDIN, STDOUT, strategy: options[:strategy])
-bytes_decoded = nil
-tms = Benchmark.measure { bytes_decoded = pipe.decode }
-exit unless options[:verbose]
-
-if tms.real < 0.1
-  warn "#{$0}: decoding took %.2f us." % (tms.real * 1_000_000)
-else
-  warn "#{$0}: decoding took %.3f seconds." % tms.real
-end
-
-throughput = (bytes_decoded * 8 / tms.real) / 1_000_000
-warn "#{$0}: mean throughput: %.3f [Mb/s]" % throughput

data/exe/z85encode

@@ -1,31 +0,0 @@
-#!/usr/bin/env ruby
-require 'cztop'
-require 'optparse'
-require 'benchmark'
-
-options = { strategy: CZTop::Z85::Pipe::Strategy::Sequential }
-OptionParser.new do |opts|
-  opts.banner = "Usage: #$0 [options]"
-
-  opts.on("-p", "--parallel", "read, encode, and write in parallel " +
-                              "using 3 threads") do
-    options[:strategy] = CZTop::Z85::Pipe::Strategy::Parallel
-  end
-  opts.on("-v", "--verbose", "print some statistics afterwards") do
-    options[:verbose] = true
-  end
-end.parse!
-
-pipe = CZTop::Z85::Pipe.new(STDIN, STDOUT, strategy: options[:strategy])
-bytes_encoded = nil
-tms = Benchmark.measure { bytes_encoded = pipe.encode }
-exit unless options[:verbose]
-
-if tms.real < 0.1
-  warn "#{$0}: encoding took %.2f us." % (tms.real * 1_000_000)
-else
-  warn "#{$0}: encoding took %.3f seconds." % tms.real
-end
-
-throughput = (bytes_encoded * 8 / tms.real) / 1_000_000
-warn "#{$0}: mean throughput: %.3f [Mb/s]" % throughput