omq 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 852e5a45a7b9f61b32004aa2079e1289291c3ac2ecc5efeb78911d88d3b63b2e
-  data.tar.gz: b475a15807b8e98d4a852ec78b07ecaa4a0b15e68d3aec2fd9b2702533cb5d5f
+  metadata.gz: 3a81ea3e22e2133f508016129454fca72393068b259400e3d47aaf92d0948136
+  data.tar.gz: 71839df55e8ae9edb9db9710b77c5449853cde909c60867958a46e8350f27ead
 SHA512:
-  metadata.gz: 0afb8f440937ae11bebe4ce3ecc1df599103f27300ed721b14437d708bd1cba1cd5b0aeb6873bd7281d054c42f6353abc29b1c8c542f4708152c2ad6b047b5f0
-  data.tar.gz: b3477d54c520f7ed09dc4647b84841c9937d863036c4301afc3110bd959fd794bbd91db56d0204f317cd66ef62bf63ad8b1772521dc48f96912ae01e9bea8f81
+  metadata.gz: 9e9d603fb6f44b53626e37d88da5dea1297f932bfbc7b3af0b32e5ab4ebdc6c2151f4b7482bca70d5060d31ffc49ba3c771603b6ed1b4dd17ed51733339de67d
+  data.tar.gz: b40525791795b8e040a4a275a628c1cdca42eab43fcabfab76407de97f669ff9c1b21d05490509c0e0f5cd0b53505c7f85281343b2c312bdb89fd3eee7d4af75

data/CHANGELOG.md

@@ -1,5 +1,92 @@
 # Changelog
 
+## Unreleased
+
+## 0.10.0 — 2026-04-01
+
+### Added
+
+- **Auto-close sockets via Async task tree** — all engine tasks (accept
+  loops, connection tasks, send/recv pumps, heartbeats, reconnect loops,
+  reapers) now live under the caller's Async task. When the `Async` block
+  exits, tasks are stopped and `ensure` blocks close IO resources.
+  Explicit `Socket#close` is no longer required (but remains available
+  and idempotent).
+- **Non-Async usage** — sockets work outside `Async do…end`. A shared IO
+  thread hosts the task tree; all blocking operations (bind, connect,
+  send, receive, close) are dispatched to it transparently via
+  `Reactor.run`. The IO thread shuts down cleanly at process exit,
+  respecting the longest linger across all sockets.
+- **Recv prefetching** — `#receive` internally drains up to 64 messages
+  per queue dequeue, buffering the excess behind a Mutex. Subsequent
+  calls return from the buffer without touching the queue. Thread-safe
+  on JRuby. TCP 64B pipelined: 30k → 221k msg/s (7x).
+
+### Changed
+
+- **Transports are pure IO** — TCP and IPC transports no longer spawn
+  tasks. They create server sockets and return them; Engine owns the
+  accept loops.
+- **Reactor simplified** — `spawn_pump` and `PumpHandle` removed.
+  Reactor exposes `root_task` (shared IO thread's root Async task)
+  and `run` (cross-thread dispatch). `stop!` respects max linger.
+- **Flatten `OMQ::ZMTP` namespace into `OMQ`** — with the ZMTP protocol
+  layer extracted to `protocol-zmtp`, the `ZMTP` sub-namespace no longer
+  makes sense. Engine, routing, transport, and mixins now live directly
+  under `OMQ::`. Protocol-zmtp types are referenced as `Protocol::ZMTP::*`.
+
+### Performance
+
+- **Direct pipe bypass for single-peer inproc** — PAIR, CHANNEL, and
+  single-peer RoundRobin types (PUSH, REQ, DEALER, CLIENT, SCATTER)
+  enqueue directly into the receiver's recv queue, skipping the
+  send_queue and send pump entirely.
+  Inproc PUSH/PULL: 200k → 980k msg/s (5x).
+- **Uncapped send queue drain** — the send pump drains the entire queue
+  per cycle instead of capping at 64 messages. IO::Stream auto-flushes
+  at 64 KB, so writes hit the wire naturally under load.
+  IPC latency −12%, TCP latency −10%.
+- **Remove `.b` allocations from PUB/SUB subscription matching** —
+  `FanOut#subscribed?` no longer creates temporary binary strings per
+  comparison; both topic and prefix are guaranteed binary at rest.
+- **Reuse `written` Set and `latest` Hash across batches** in all send
+  pumps (fan-out, round-robin, router, server, peer, rep, radio),
+  eliminating per-batch object allocation.
+- **O(1) `connection_removed` for identity-routed sockets** — Router,
+  Server, and Peer now maintain a reverse index instead of scanning.
+- **`freeze_message` fast path** — skip `.b.freeze` when the string is
+  already a frozen binary string.
+- **Pre-frozen empty frame constants** for REQ/REP delimiter frames.
+
+### Fixed
+
+- **Reapers no longer crash on inproc DirectPipe** — PUSH and SCATTER
+  reapers skipped for DirectPipe connections that have no receive queue
+  (latent bug previously masked by transient task error swallowing).
+- **`send_pump_idle?` made public** on all routing strategies — was
+  accidentally private, crashing `Engine#drain_send_queues` with
+  linger > 0.
+
+## 0.9.0 — 2026-03-31
+
+### Breaking
+
+- **CLI extracted into omq-cli gem** — the `omq` executable, all CLI
+  code (`lib/omq/cli/`), tests, and `CLI.md` have moved to the
+  [omq-cli](https://github.com/paddor/omq-cli) gem. `gem install omq`
+  no longer provides the `omq` command — use `gem install omq-cli`.
+- **`OMQ.outgoing` / `OMQ.incoming`** registration API moved to omq-cli.
+  Library-only users are unaffected (these were CLI-specific).
+
+### Changed
+
+- **Gemspec is library-only** — no `exe/`, no `bindir`, no `executables`.
+- **README** — restored title, replaced inline CLI section with a
+  pointer to omq-cli, fixed ZMTP attribution for protocol-zmtp.
+- **DESIGN.md** — acknowledged protocol-zmtp, clarified transient
+  task / linger interaction, removed ZMTP wire protocol section (now in
+  protocol-zmtp), simplified inproc description, removed CLI section.
+
 ## 0.8.0 — 2026-03-31
 
 ### Breaking

data/README.md

@@ -1,4 +1,4 @@
-# OMQ — ZeroMQ in pure Ruby
+# OMQ — Where did the C dependency go!?
 
 [![CI](https://github.com/zeromq/omq/actions/workflows/ci.yml/badge.svg)](https://github.com/zeromq/omq/actions/workflows/ci.yml)
 [![Gem Version](https://img.shields.io/gem/v/omq?color=e9573f)](https://rubygems.org/gems/omq)
@@ -7,7 +7,7 @@
 
 `gem install omq` — that's it. No libzmq, no compiler, no system packages. Just Ruby.
 
-OMQ implements the [ZMTP 3.1](https://rfc.zeromq.org/spec/23/) wire protocol from scratch using [Async](https://github.com/socketry/async) fibers. It speaks native ZeroMQ on the wire and interoperates with libzmq, pyzmq, CZMQ, and everything else in the ZMQ ecosystem.
+OMQ builds ZeroMQ socket patterns on top of [protocol-zmtp](https://github.com/paddor/protocol-zmtp) (a pure Ruby [ZMTP 3.1](https://rfc.zeromq.org/spec/23/) codec) using [Async](https://github.com/socketry/async) fibers. It speaks native ZeroMQ on the wire and interoperates with libzmq, pyzmq, CZMQ, and everything else in the ZMQ ecosystem.
 
 > **234k msg/s** inproc | **49k msg/s** ipc | **36k msg/s** tcp
 >
@@ -31,12 +31,12 @@ See [GETTING_STARTED.md](GETTING_STARTED.md) for a ~30 min walkthrough of all ma
 
 - **Zero dependencies on C** — no extensions, no FFI, no libzmq. `gem install` just works everywhere
 - **Fast** — YJIT-optimized hot paths, batched sends, 234k msg/s inproc with 12 µs latency
-- **`omq` CLI** — pipe, filter, and transform messages from the terminal with Ruby eval, Ractor parallelism, and [script handlers](CLI.md#script-handlers--r)
+- **[`omq` CLI](https://github.com/paddor/omq-cli)** — `gem install omq-cli` for a command-line tool with Ruby eval, Ractor parallelism, and script handlers
 - **Every socket pattern** — req/rep, pub/sub, push/pull, dealer/router, xpub/xsub, pair, and all draft types
 - **Every transport** — tcp, ipc (Unix domain sockets), inproc (in-process queues)
 - **Async-native** — built on fibers, non-blocking from the ground up. A shared IO thread handles sockets outside of Async — no reactor needed for simple scripts
 - **Wire-compatible** — interoperates with libzmq, pyzmq, CZMQ over tcp and ipc
-- **Bind/connect order doesn't matter** — connect before bind, bind before connect, peers come and go. ZeroMQ reconnects and requeues automatically
+- **Bind/connect order doesn't matter** — connect before bind, bind before connect, peers come and go. ZeroMQ reconnects automatically and queued messages drain when peers arrive
 
 For architecture internals, see [DESIGN.md](DESIGN.md).
 
@@ -150,58 +150,18 @@ All sockets are thread-safe. Default HWM is 1000 messages per socket. Classes li
 | **PEER** | Routing-ID | Fair-queue | Block |
 | **CHANNEL** | Exclusive 1-to-1 | Exclusive 1-to-1 | Block |
 
-## omq — CLI tool
+## CLI
 
-`omq` is a command-line tool for sending and receiving messages on any OMQ socket. Like `nngcat` from libnng, but with Ruby superpowers.
+Install [omq-cli](https://github.com/paddor/omq-cli) for a command-line tool that sends, receives, pipes, and transforms ZeroMQ messages from the terminal:
 
 ```sh
-# Echo server
-omq rep -b tcp://:5555 --echo
-
-# Upcase server — -e evals Ruby on each incoming message
-omq rep -b tcp://:5555 -e '$F.map(&:upcase)'
+gem install omq-cli
 
-# Client
+omq rep -b tcp://:5555 --echo
 echo "hello" | omq req -c tcp://localhost:5555
-# => HELLO
-
-# PUB/SUB
-omq sub -b tcp://:5556 -s "weather."  &
-echo "weather.nyc 72F" | omq pub -c tcp://localhost:5556 -d 0.3
-
-# Pipeline with filtering
-tail -f /var/log/syslog | omq push -c tcp://collector:5557
-omq pull -b tcp://:5557 -e 'next unless /error/; $F'
-
-# Transform outgoing messages with -E
-echo hello | omq push -c tcp://localhost:5557 -E '$F.map(&:upcase)'
-
-# REQ: transform request and reply independently
-echo hello | omq req -c tcp://localhost:5555 \
-  -E '$F.map(&:upcase)' -e '$F.map(&:reverse)'
-
-# Pipe: PULL → eval → PUSH in one process
-omq pipe -c ipc://@work -c ipc://@sink -e '$F.map(&:upcase)'
-
-# Pipe with Ractor workers for CPU parallelism (-P = all CPUs)
-omq pipe -c ipc://@work -c ipc://@sink -P -r./fib -e 'fib(Integer($_)).to_s'
-```
-
-`-e` (recv-eval) transforms incoming messages, `-E` (send-eval) transforms outgoing messages. `$F` is the message parts array, `$_` is the first part. Use `-r` to require gems or load scripts that register handlers via `OMQ.incoming` / `OMQ.outgoing`:
-
-```ruby
-# my_handler.rb
-db = DB.connect("postgres://localhost/app")
-
-OMQ.incoming { db.query($F.first) }
-at_exit { db.close }
-```
-
-```sh
-omq pull -b tcp://:5557 -r./my_handler.rb
 ```
 
-See [CLI.md](CLI.md) for full documentation, or `omq --help` / `omq --examples`.
+See the [omq-cli README](https://github.com/paddor/omq-cli) for full documentation.
 
 ## Development
 

data/lib/omq/channel.rb

@@ -2,9 +2,9 @@
 
 module OMQ
   class CHANNEL < Socket
-    include ZMTP::Readable
-    include ZMTP::Writable
-    include ZMTP::SingleFrame
+    include Readable
+    include Writable
+    include SingleFrame
 
     def initialize(endpoints = nil, linger: 0)
       _init_engine(:CHANNEL, linger: linger)

data/lib/omq/client_server.rb

@@ -2,9 +2,9 @@
 
 module OMQ
   class CLIENT < Socket
-    include ZMTP::Readable
-    include ZMTP::Writable
-    include ZMTP::SingleFrame
+    include Readable
+    include Writable
+    include SingleFrame
 
     def initialize(endpoints = nil, linger: 0)
       _init_engine(:CLIENT, linger: linger)
@@ -13,9 +13,9 @@ module OMQ
   end
 
   class SERVER < Socket
-    include ZMTP::Readable
-    include ZMTP::Writable
-    include ZMTP::SingleFrame
+    include Readable
+    include Writable
+    include SingleFrame
 
     def initialize(endpoints = nil, linger: 0)
       _init_engine(:SERVER, linger: linger)