omq 0.3.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27a1d700594261a36d3212b00ff84e15be3053a32db07a04a48aa0eb52fec902
-  data.tar.gz: 2797e4863af5cfcde9fe446c79929705e6ab17656ba016532b54d6c6b57564b9
+  metadata.gz: dd6af0ae414feae27d1119fe4f1144b680e7e039229d512fe2915cd0289fc4dc
+  data.tar.gz: b68f9a321eb93350fc175bd603f8d4c29e23518b6b2dfd2a13072eade5904c8f
 SHA512:
-  metadata.gz: a116b039dc996a0099bbb86e8c138fd71f03051bd23c142b653e1c8e932e541245476bed51a47183ecb3723f9f86b30f36b6e3956b77494f8d77c924354f39ad
-  data.tar.gz: bdd7a62bb68390c942ebb1517981ca69d0efab007f3be7d3149fcccb525ad9b2cb279689ba2ec640db0f6057d6d7219e804074bb5ba4eb4d8339517bf6de5805
+  metadata.gz: 3e17e9b4d867a7d2972b8caa4eff31dfd3c77095c60e9e5d9fdb53bc2646458dbfff244228065c145f0eb818d32f68bc196a7d0099fa4a5f2f02142f4c9a94b2
+  data.tar.gz: d0a7cc664076ea333433e5e14b5d1701219e4bf15200302cf0ab4420e928d50b2fe8d08d35889d69de6f35f7715b40f423195d33055a67f15af18404ee850536

data/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## 0.4.1 — 2026-03-27
+
+### Improved
+
+- Explicit flush after `send_message`/`send_command` instead of
+  `minimum_write_size: 0` workaround — enables write buffering
+  (multi-frame messages coalesced into fewer syscalls).
+  **+68% inproc throughput** (145k → 244k msg/s),
+  **-40% inproc latency** (15 → 9 µs)
+
+### Fixed
+
+- Require `async ~> 2.38` for `Promise#wait?` (was `~> 2`)
+
+## 0.4.0 — 2026-03-27
+
+### Added (omqcat)
+
+- `--curve-server` flag — generates ephemeral keypair, prints
+  `OMQ_SERVER_KEY=...` to stderr for easy copy-paste
+- `--curve-server-key KEY` flag — CURVE client mode from the CLI
+- `--echo` flag for REP — explicit echo mode
+- REP reads stdin/`-F` as reply source (one line per reply, exits at EOF)
+- REP without a reply source now aborts with a helpful error message
+
+### Changed
+
+- CURVE env vars renamed: `OMQ_SERVER_KEY`, `OMQ_SERVER_PUBLIC`,
+  `OMQ_SERVER_SECRET` (was `SERVER_KEY`, `SERVER_PUBLIC`, `SERVER_SECRET`)
+- REP with `--echo`/`-D`/`-e` serves forever by default (like a server).
+  Use `-n 1` for one-shot, `-n` to limit exchanges. Stdin/`-F` replies
+  naturally terminate at EOF.
+
 ## 0.3.2 — 2026-03-26
 
 ### Improved

data/README.md

@@ -7,11 +7,11 @@
 
 Pure Ruby implementation of the [ZMTP 3.1](https://rfc.zeromq.org/spec/23/) wire protocol ([ZeroMQ](https://zeromq.org/)) using the [Async](https://github.com/socketry/async) gem. No native libraries required.
 
-> **145k msg/s** inproc | **40k msg/s** ipc | **32k msg/s** tcp
+> **244k msg/s** inproc | **47k msg/s** ipc | **36k msg/s** tcp
 >
-> **15 µs** inproc latency | **62 µs** ipc | **88 µs** tcp
+> **9 µs** inproc latency | **47 µs** ipc | **61 µs** tcp
 >
-> Ruby 4.0 + YJIT on a Linux VM on a 2019 MacBook Pro (Intel) — [223k msg/s with io_uring](bench/README.md#io_uring)
+> Ruby 4.0 + YJIT on a Linux VM on a 2019 MacBook Pro (Intel) — [~340k msg/s with io_uring](bench/README.md#io_uring)
 
 ---
 
@@ -121,19 +121,19 @@ req = ØMQ::REQ.new(">tcp://localhost:5555")
 
 ## Performance
 
-Benchmarked with benchmark-ips on Linux x86_64 (Ruby 4.0.1 +YJIT):
+Benchmarked with benchmark-ips on Linux x86_64 (Ruby 4.0.2 +YJIT):
 
 #### Throughput (push/pull, 64 B messages)
 
 | inproc | ipc | tcp |
 |--------|-----|-----|
-| 184k/s | 35k/s | 18k/s |
+| 244k/s | 47k/s | 36k/s |
 
 #### Latency (req/rep roundtrip)
 
 | inproc | ipc | tcp |
 |--------|-----|-----|
-| 13 µs | 70 µs | 97 µs |
+| 9 µs | 47 µs | 61 µs |
 
 See [`bench/`](bench/) for full results and scripts.
 
@@ -142,7 +142,10 @@ See [`bench/`](bench/) for full results and scripts.
 `omqcat` is a command-line tool for sending and receiving messages on any OMQ socket. Like `nngcat` from libnng, but with Ruby superpowers.
 
 ```sh
-# Echo server in one line
+# Echo server
+omqcat rep -b tcp://:5555 --echo
+
+# Upcase server in one line
 omqcat rep -b tcp://:5555 -e '$F.map(&:upcase)'
 
 # Client
@@ -170,8 +173,10 @@ omqcat pull -b tcp://:5557 -J
 omqcat push -c tcp://remote:5557 -z < data.txt
 omqcat pull -b tcp://:5557 -z
 
-# CURVE encryption (auto-detected from env vars)
-SERVER_KEY=... omqcat req -c tcp://secure:5555 -D "secret"
+# CURVE encryption
+omqcat rep -b tcp://:5555 -D "secret" --curve-server
+# prints: OMQ_SERVER_KEY='...'
+omqcat req -c tcp://localhost:5555 --curve-server-key '...'
 ```
 
 The `-e` flag runs Ruby inside the socket instance — the full socket API (`self <<`, `send`, `subscribe`, ...) is available. Use `-r` to require gems:

data/exe/omqcat

@@ -30,7 +30,7 @@ opts = {
   identity:     nil,
   target:       nil,
   interval:     nil,
-  count:        0,
+  count:        nil,
   delay:        nil,
   recv_timeout: nil,
   send_timeout: nil,
@@ -48,7 +48,8 @@ parser = OptionParser.new do |o|
   o.on("-c", "--connect URL", "Connect to endpoint (repeatable)")   { |v| opts[:connects] << v }
   o.on("-b", "--bind URL",    "Bind to endpoint (repeatable)")      { |v| opts[:binds] << v }
 
-  o.separator "\nData source:"
+  o.separator "\nData source (REP: reply source):"
+  o.on(      "--echo",        "Echo received messages back (REP)")   { opts[:echo] = true }
   o.on("-D", "--data DATA",   "Message data (literal string)")      { |v| opts[:data] = v }
   o.on("-F", "--file FILE",   "Read message from file (- = stdin)") { |v| opts[:file] = v }
 
@@ -80,6 +81,11 @@ parser = OptionParser.new do |o|
   o.on("-e", "--eval EXPR", "Eval Ruby for each message ($F = parts)") { |v| opts[:expr] = v }
   o.on("-r", "--require LIB", "Require a Ruby library (repeatable)")   { |v| require v }
 
+  o.separator "\nCURVE encryption (requires omq-curve gem):"
+  o.on("--curve-server",         "Enable CURVE as server (generates keypair)") { opts[:curve_server] = true }
+  o.on("--curve-server-key KEY", "Enable CURVE as client (server's Z85 public key)") { |v| opts[:curve_server_key] = v }
+  o.separator "  Env vars: OMQ_SERVER_KEY (client), OMQ_SERVER_PUBLIC + OMQ_SERVER_SECRET (server)"
+
   o.separator "\nOther:"
   o.on("-v", "--verbose", "Print connection events to stderr") { opts[:verbose] = true }
   o.on("-q", "--quiet",   "Suppress message output")           { opts[:quiet] = true }
@@ -216,21 +222,31 @@ end
 
 # ── CURVE setup ─────────────────────────────────────────────────────
 
-def setup_curve(sock)
-  if ENV["SERVER_KEY"]
+def setup_curve(sock, opts)
+  server_key_z85 = opts[:curve_server_key] || ENV["OMQ_SERVER_KEY"]
+  server_mode    = opts[:curve_server] || (ENV["OMQ_SERVER_PUBLIC"] && ENV["OMQ_SERVER_SECRET"])
+
+  if server_key_z85
+    # Client mode
     require "omq/curve"
-    server_key = OMQ::Z85.decode(ENV["SERVER_KEY"])
+    server_key = OMQ::Z85.decode(server_key_z85)
     client_key = RbNaCl::PrivateKey.generate
     sock.mechanism = OMQ::Curve.client(
       client_key.public_key.to_s, client_key.to_s, server_key: server_key
     )
-    $stderr.puts "CURVE client mode" if $VERBOSE
-  elsif ENV["SERVER_PUBLIC"] && ENV["SERVER_SECRET"]
+  elsif server_mode
+    # Server mode
     require "omq/curve"
-    server_pub = OMQ::Z85.decode(ENV["SERVER_PUBLIC"])
-    server_sec = OMQ::Z85.decode(ENV["SERVER_SECRET"])
+    if ENV["OMQ_SERVER_PUBLIC"] && ENV["OMQ_SERVER_SECRET"]
+      server_pub = OMQ::Z85.decode(ENV["OMQ_SERVER_PUBLIC"])
+      server_sec = OMQ::Z85.decode(ENV["OMQ_SERVER_SECRET"])
+    else
+      key        = RbNaCl::PrivateKey.generate
+      server_pub = key.public_key.to_s
+      server_sec = key.to_s
+    end
     sock.mechanism = OMQ::Curve.server(server_pub, server_sec)
-    $stderr.puts "SERVER_KEY=#{ENV["SERVER_PUBLIC"]}"
+    $stderr.puts "OMQ_SERVER_KEY='#{OMQ::Z85.encode(server_pub)}'"
   end
 rescue LoadError
   abort "omq-curve gem required for CURVE encryption: gem install omq-curve"
@@ -281,6 +297,10 @@ def eval_expr(parts, sock, opts)
   end
 end
 
+def count_reached?(i, opts)
+  opts[:count] && opts[:count] > 0 && i >= opts[:count]
+end
+
 def output(parts, opts)
   return if opts[:quiet]
   parts = [""] if parts.nil?
@@ -304,7 +324,7 @@ def send_loop(sock, opts)
       sleep(opts[:delay]) if opts[:delay] && i == 0
       send_msg(sock, parts, opts) if parts
       i += 1
-      break if opts[:count] > 0 && i >= opts[:count]
+      break if count_reached?(i, opts)
       if opts[:interval]
         sleep(opts[:interval])
       else
@@ -319,7 +339,7 @@ def send_loop(sock, opts)
       sleep(opts[:delay]) if opts[:delay] && i == 0
       send_msg(sock, parts, opts) if parts
       i += 1
-      break if opts[:count] > 0 && i >= opts[:count]
+      break if count_reached?(i, opts)
       sleep(opts[:interval]) if opts[:interval]
     end
   end
@@ -332,7 +352,7 @@ def recv_loop(sock, opts)
     parts = eval_expr(parts, sock, opts)
     output(parts, opts)
     i += 1
-    break if opts[:count] > 0 && i >= opts[:count]
+    break if count_reached?(i, opts)
   end
 end
 
@@ -347,7 +367,7 @@ def req_loop(sock, opts)
     reply = eval_expr(reply, sock, opts)
     output(reply, opts)
     i += 1
-    break if opts[:count] > 0 && i >= opts[:count]
+    break if count_reached?(i, opts)
     if opts[:interval]
       sleep(opts[:interval])
     elsif !opts[:data] && !opts[:file]
@@ -366,13 +386,19 @@ def rep_loop(sock, opts)
       reply = eval_expr(msg, sock, opts)
       output(reply, opts)
       send_msg(sock, reply || [""], opts)
-    else
+    elsif opts[:echo]
+      output(msg, opts)
+      send_msg(sock, msg, opts)
+    elsif opts[:data] || opts[:file] || !$stdin.tty?
+      reply = read_next(opts)
+      break unless reply  # EOF on stdin/-F
       output(msg, opts)
-      reply = opts[:data] ? parse_input(opts[:data] + "\n", opts[:format]) : msg
       send_msg(sock, reply, opts)
+    else
+      abort "REP needs a reply source: --echo, --data, --file, -e, or stdin pipe"
     end
     i += 1
-    break if opts[:count] > 0 && i >= opts[:count]
+    break if count_reached?(i, opts)
   end
 end
 
@@ -384,7 +410,7 @@ def pair_loop(sock, opts, task)
       parts = eval_expr(parts, sock, opts)
       output(parts, opts)
       i += 1
-      break if opts[:count] > 0 && i >= opts[:count]
+      break if count_reached?(i, opts)
     end
   end
 
@@ -397,13 +423,13 @@ def pair_loop(sock, opts, task)
       sleep(opts[:delay]) if opts[:delay] && i == 0
       send_msg(sock, parts, opts) if parts
       i += 1
-      break if opts[:count] > 0 && i >= opts[:count]
+      break if count_reached?(i, opts)
       break if (opts[:data] || opts[:file]) && !opts[:interval]
       sleep(opts[:interval]) if opts[:interval]
     end
   end
 
-  if opts[:count] > 0
+  if opts[:count] && opts[:count] > 0
     receiver.wait
     sender.stop
   else
@@ -425,7 +451,7 @@ def router_loop(sock, opts, task)
       result = eval_expr([id_display, *parts], sock, opts)
       output(result, opts)
       i += 1
-      break if opts[:count] > 0 && i >= opts[:count]
+      break if count_reached?(i, opts)
     end
   end
 
@@ -440,7 +466,7 @@ def router_loop(sock, opts, task)
       end
       send_msg(sock, parts, opts)
       i += 1
-      break if opts[:count] > 0 && i >= opts[:count]
+      break if count_reached?(i, opts)
       break if (opts[:data] || opts[:file]) && !opts[:interval]
       sleep(opts[:interval]) if opts[:interval]
     end
@@ -448,7 +474,7 @@ def router_loop(sock, opts, task)
 
   # If count is set, the receiver will exit when count is reached.
   # Otherwise, wait for Ctrl-C.
-  if opts[:count] > 0
+  if opts[:count] && opts[:count] > 0
     receiver.wait
     sender.stop
   else
@@ -473,7 +499,7 @@ Async do |task|
   sock.send_timeout = opts[:send_timeout] if opts[:send_timeout]
   sock.identity     = opts[:identity]     if opts[:identity]
 
-  setup_curve(sock)
+  setup_curve(sock, opts)
 
   opts[:binds].each do |url|
     sock.bind(url)

data/lib/omq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OMQ
-  VERSION = "0.3.2"
+  VERSION = "0.4.1"
 end

data/lib/omq/zmtp/connection.rb

@@ -92,6 +92,7 @@ module OMQ
               @io.write(Codec::Frame.new(part, more: more).to_wire)
             end
           end
+          @io.flush
         end
       end
 
@@ -156,6 +157,7 @@ module OMQ
           else
             @io.write(command.to_frame.to_wire)
           end
+          @io.flush
         end
       end
 

data/lib/omq/zmtp/transport/ipc.rb

@@ -32,7 +32,7 @@ module OMQ
               loop do
                 client = server.accept
                 Reactor.run do
-                  engine.handle_accepted(IO::Stream::Buffered.wrap(client, minimum_write_size: 0), endpoint: endpoint)
+                  engine.handle_accepted(IO::Stream::Buffered.wrap(client), endpoint: endpoint)
                 rescue ProtocolError, *ZMTP::CONNECTION_LOST
                   # peer disconnected during handshake
                 rescue
@@ -57,7 +57,7 @@ module OMQ
             path = parse_path(endpoint)
             sock_path = to_socket_path(path)
             sock = UNIXSocket.new(sock_path)
-            engine.handle_connected(IO::Stream::Buffered.wrap(sock, minimum_write_size: 0), endpoint: endpoint)
+            engine.handle_connected(IO::Stream::Buffered.wrap(sock), endpoint: endpoint)
           end
 
           private

data/lib/omq/zmtp/transport/tcp.rb

@@ -29,7 +29,7 @@ module OMQ
               loop do
                 client = server.accept
                 Reactor.run do
-                  engine.handle_accepted(IO::Stream::Buffered.wrap(client, minimum_write_size: 0), endpoint: resolved)
+                  engine.handle_accepted(IO::Stream::Buffered.wrap(client), endpoint: resolved)
                 rescue ProtocolError, *ZMTP::CONNECTION_LOST
                   # peer disconnected during handshake
                 rescue
@@ -53,7 +53,7 @@ module OMQ
           def connect(endpoint, engine)
             host, port = parse_endpoint(endpoint)
             sock = TCPSocket.new(host, port)
-            engine.handle_connected(IO::Stream::Buffered.wrap(sock, minimum_write_size: 0), endpoint: endpoint)
+            engine.handle_connected(IO::Stream::Buffered.wrap(sock), endpoint: endpoint)
           end
 
           private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omq
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Patrik Wenger
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.38'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.38'
 - !ruby/object:Gem::Dependency
   name: io-stream
   requirement: !ruby/object:Gem::Requirement