omq 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb02b0e08db21f4d0db4bb376a35759ca709ef80d175a306179c3710e8048e9d
-  data.tar.gz: 41bfa63e9868e6a5d10c97e9751ebe227f8937be734d9f9bc5c618619cb1906c
+  metadata.gz: 02d85dfeec36f9d537cdfac7512a4a5edbfbe95145ae9583e8f5428a43a2548d
+  data.tar.gz: 1598f1cdecdc0523cf4263a72318f0500b1bd9dccb46da703817fd0b30c74315
 SHA512:
-  metadata.gz: cf95700a644923f1598944501e10775de5ba0cfd277c375f3701c93e09a5e1928e495acea2e09eb5224f87143e55526f851852c2ba67d92409a5e0da62ec5266
-  data.tar.gz: 9b299ca752fee2e1cba919d65bd7a377494e8067d111f27ac53c8dc2a35b3c9c3d0547386e38417656f58b746ea3dda6ea5b8292e1d9f9230736150561aad1b8
+  metadata.gz: ee523b073066febf851dc2427b8ddd86c62bc44580a3a9c4283a4d72345ee52048e07a396da1db0de7265f7a641ac6aafe02827542a2786833c8e78b0a25bebf
+  data.tar.gz: 88933632f2e57c092090af0a322772db4431af55f85f4e9f41c21df2aa88d68bc9641ef3691a6826335b89b8b030275576b978ebf9f558a22ab4a329da5c3bbe

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.2.2 — 2026-03-26
+
+### Added
+
+- `ØMQ` alias for `OMQ` — because Ruby can
+
+## 0.2.1 — 2026-03-26
+
+### Improved
+
+- Replace `IO::Buffer` with `pack`/`unpack1`/`getbyte`/`byteslice` in
+  frame, command, and greeting codecs — up to 68% higher throughput for
+  large messages, 21% lower TCP latency
+
 ## 0.2.0 — 2026-03-26
 
 ### Changed

data/README.md

@@ -7,7 +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.
 
-> **186k msg/s** inproc throughput | **12 µs** req/rep roundtrip latency | pure Ruby + YJIT
+> **167k msg/s** inproc | **42k msg/s** ipc | **32k msg/s** tcp
+>
+> **15 µs** inproc latency | **62 µs** ipc | **88 µs** tcp
+>
+> Ruby 4.0 + YJIT on a Linux VM on a 2019 MacBook Pro (Intel)
 
 ---
 
@@ -25,7 +29,7 @@ Modern Ruby has closed the gap:
 
 - **YJIT** — JIT-compiled hot paths close the throughput gap with C extensions
 - **Fiber Scheduler** — non-blocking I/O without callbacks or threads (`Async` builds on this)
-- **`IO::Buffer`** — zero-copy binary reads/writes, no manual `String#b` packing
+- **`io-stream`** — buffered I/O with read-ahead, from the Async ecosystem
 
 When [CZTop](https://github.com/paddor/cztop) was written, none of this existed. Today, a pure Ruby ZMTP implementation is fast enough for production use — and you get `gem install` with no compiler toolchain, no system packages, and no segfaults.
 
@@ -109,7 +113,11 @@ end
 | Routing | `DEALER`, `ROUTER` | bidirectional |
 | Exclusive pair | `PAIR` | bidirectional |
 
-All classes live under `OMQ::`.
+All classes live under `OMQ::`. For the purists, `ØMQ` is an alias:
+
+```ruby
+req = ØMQ::REQ.new(">tcp://localhost:5555")
+```
 
 ## Performance
 

data/lib/omq/version.rb

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

data/lib/omq/zmtp/codec/command.rb

@@ -39,11 +39,7 @@ module OMQ
         #
         def to_body
           name_bytes = @name.b
-          buf = IO::Buffer.new(1 + name_bytes.bytesize + @data.bytesize)
-          buf.set_value(:U8, 0, name_bytes.bytesize)
-          buf.set_string(name_bytes, 1)
-          buf.set_string(@data, 1 + name_bytes.bytesize)
-          buf.get_string(0, buf.size, Encoding::BINARY)
+          name_bytes.bytesize.chr.b + name_bytes + @data
         end
 
         # Encodes as a complete command Frame.
@@ -64,12 +60,11 @@ module OMQ
           body = body.b
           raise ProtocolError, "command body too short" if body.bytesize < 1
 
-          buf = IO::Buffer.for(body)
-          name_len = buf.get_value(:U8, 0)
+          name_len = body.getbyte(0)
 
           raise ProtocolError, "command name truncated" if body.bytesize < 1 + name_len
 
-          name = buf.get_string(1, name_len, Encoding::BINARY)
+          name = body.byteslice(1, name_len)
           data = body.byteslice(1 + name_len..)
           new(name, data)
         end
@@ -113,12 +108,8 @@ module OMQ
         # @return [Command]
         #
         def self.ping(ttl: 0, context: "".b)
-          # TTL is encoded as 2-byte big-endian value in tenths of a second
           ttl_ds = (ttl * 10).to_i
-          buf = IO::Buffer.new(2 + context.bytesize)
-          buf.set_value(:U16, 0, ttl_ds)
-          buf.set_string(context.b, 2) if context.bytesize > 0
-          new("PING", buf.get_string(0, buf.size, Encoding::BINARY))
+          new("PING", [ttl_ds].pack("n") + context.b)
         end
 
         # Builds a PONG command.
@@ -135,8 +126,7 @@ module OMQ
         # @return [Array(Numeric, String)] [ttl_seconds, context_bytes]
         #
         def ping_ttl_and_context
-          buf = IO::Buffer.for(@data)
-          ttl_ds = buf.get_value(:U16, 0)
+          ttl_ds  = @data.unpack1("n")
           context = @data.bytesize > 2 ? @data.byteslice(2..) : "".b
           [ttl_ds / 10.0, context]
         end
@@ -157,17 +147,13 @@ module OMQ
         #
         def self.encode_properties(props)
           parts = props.map do |name, value|
-            name_bytes = name.b
+            name_bytes  = name.b
             value_bytes = value.b
-            buf = IO::Buffer.new(1 + name_bytes.bytesize + 4 + value_bytes.bytesize)
-            buf.set_value(:U8, 0, name_bytes.bytesize)
-            buf.set_string(name_bytes, 1)
-            buf.set_value(:U32, 1 + name_bytes.bytesize, value_bytes.bytesize) # big-endian
-            buf.set_string(value_bytes, 1 + name_bytes.bytesize + 4)
-            buf.get_string(0, buf.size, Encoding::BINARY)
+            name_bytes.bytesize.chr.b + name_bytes + [value_bytes.bytesize].pack("N") + value_bytes
           end
           parts.join
         end
+
         # Decodes a ZMTP property list from binary data.
         #
         # @param data [String] binary property list
@@ -176,24 +162,23 @@ module OMQ
         #
         def self.decode_properties(data)
           result = {}
-          buf    = IO::Buffer.for(data)
           offset = 0
 
           while offset < data.bytesize
             raise ProtocolError, "property name truncated" if offset + 1 > data.bytesize
-            name_len = buf.get_value(:U8, offset)
+            name_len = data.getbyte(offset)
             offset += 1
 
             raise ProtocolError, "property name truncated" if offset + name_len > data.bytesize
-            name = buf.get_string(offset, name_len, Encoding::BINARY)
+            name = data.byteslice(offset, name_len)
             offset += name_len
 
             raise ProtocolError, "property value length truncated" if offset + 4 > data.bytesize
-            value_len = buf.get_value(:U32, offset)
+            value_len = data.byteslice(offset, 4).unpack1("N")
             offset += 4
 
             raise ProtocolError, "property value truncated" if offset + value_len > data.bytesize
-            value = buf.get_string(offset, value_len, Encoding::BINARY)
+            value = data.byteslice(offset, value_len)
             offset += value_len
 
             result[name] = value

data/lib/omq/zmtp/codec/frame.rb

@@ -46,52 +46,37 @@ module OMQ
         # @return [String] binary wire representation (flags + size + body)
         #
         def to_wire
-          size = @body.bytesize
+          size  = @body.bytesize
           flags = 0
           flags |= FLAGS_MORE if @more
           flags |= FLAGS_COMMAND if @command
 
           if size > SHORT_MAX
-            flags |= FLAGS_LONG
-            buf = IO::Buffer.new(9 + size)
-            buf.set_value(:U8, 0, flags)
-            buf.set_value(:U64, 1, size) # big-endian
-            buf.set_string(@body, 9)
-            buf.get_string(0, 9 + size, Encoding::BINARY)
+            (flags | FLAGS_LONG).chr.b + [size].pack("Q>") + @body
           else
-            buf = IO::Buffer.new(2 + size)
-            buf.set_value(:U8, 0, flags)
-            buf.set_value(:U8, 1, size)
-            buf.set_string(@body, 2)
-            buf.get_string(0, 2 + size, Encoding::BINARY)
+            flags.chr.b + size.chr.b + @body
           end
         end
 
         # Reads one frame from an IO-like object.
         #
-        # @param io [#read] must support read(n) returning exactly n bytes
+        # @param io [#read_exactly] must support read_exactly(n)
         # @return [Frame]
         # @raise [ProtocolError] on invalid frame
         # @raise [EOFError] if the connection is closed
         #
         def self.read_from(io)
-          flags_byte = io.read_exactly(1)
-          flags_buf = IO::Buffer.for(flags_byte)
-          flags = flags_buf.get_value(:U8, 0)
+          flags = io.read_exactly(1).getbyte(0)
 
-          more = (flags & FLAGS_MORE) != 0
-          long = (flags & FLAGS_LONG) != 0
+          more    = (flags & FLAGS_MORE) != 0
+          long    = (flags & FLAGS_LONG) != 0
           command = (flags & FLAGS_COMMAND) != 0
 
-          if long
-            size_bytes = io.read_exactly(8)
-            size_buf = IO::Buffer.for(size_bytes)
-            size = size_buf.get_value(:U64, 0) # big-endian
-          else
-            size_byte = io.read_exactly(1)
-            size_buf = IO::Buffer.for(size_byte)
-            size = size_buf.get_value(:U8, 0)
-          end
+          size = if long
+                   io.read_exactly(8).unpack1("Q>")
+                 else
+                   io.read_exactly(1).getbyte(0)
+                 end
 
           body = size > 0 ? io.read_exactly(size) : "".b
 

data/lib/omq/zmtp/codec/greeting.rb

@@ -33,26 +33,11 @@ module OMQ
         # @return [String] 64-byte binary greeting
         #
         def self.encode(mechanism: "NULL", as_server: false)
-          buf = IO::Buffer.new(SIZE)
-          buf.clear
-
-          # Signature
-          buf.set_value(:U8, 0, SIGNATURE_START)
-          # bytes 1-8 are already 0x00
-          buf.set_value(:U8, 9, SIGNATURE_END)
-
-          # Version
-          buf.set_value(:U8, 10, VERSION_MAJOR)
-          buf.set_value(:U8, 11, VERSION_MINOR)
-
-          # Mechanism (null-padded)
-          buf.set_string(mechanism.b, MECHANISM_OFFSET)
-
-          # As-server flag
-          buf.set_value(:U8, AS_SERVER_OFFSET, as_server ? 1 : 0)
-
-          # Filler bytes 33-63 are already 0x00
-          buf.get_string(0, SIZE, Encoding::BINARY)
+          buf = "\xFF".b + ("\x00" * 8) + "\x7F".b
+          buf << [VERSION_MAJOR, VERSION_MINOR].pack("CC")
+          buf << mechanism.b.ljust(MECHANISM_LENGTH, "\x00")
+          buf << (as_server ? "\x01" : "\x00")
+          buf << ("\x00" * 31)
         end
 
         # Decodes a ZMTP greeting.
@@ -64,24 +49,21 @@ module OMQ
         def self.decode(data)
           raise ProtocolError, "greeting too short (#{data.bytesize} bytes)" if data.bytesize < SIZE
 
-          buf = IO::Buffer.for(data.b)
+          data = data.b
 
-          # Validate signature
-          unless buf.get_value(:U8, 0) == SIGNATURE_START &&
-                 buf.get_value(:U8, 9) == SIGNATURE_END
+          unless data.getbyte(0) == SIGNATURE_START && data.getbyte(9) == SIGNATURE_END
             raise ProtocolError, "invalid greeting signature"
           end
 
-          major = buf.get_value(:U8, 10)
-          minor = buf.get_value(:U8, 11)
+          major = data.getbyte(10)
+          minor = data.getbyte(11)
 
           unless major >= 3
             raise ProtocolError, "unsupported ZMTP version #{major}.#{minor} (need >= 3.0)"
           end
 
-          mechanism = buf.get_string(MECHANISM_OFFSET, MECHANISM_LENGTH, Encoding::BINARY)
-                        .delete("\x00")
-          as_server = buf.get_value(:U8, AS_SERVER_OFFSET) == 1
+          mechanism = data.byteslice(MECHANISM_OFFSET, MECHANISM_LENGTH).delete("\x00")
+          as_server = data.getbyte(AS_SERVER_OFFSET) == 1
 
           {
             major:     major,

data/lib/omq.rb

@@ -17,3 +17,6 @@ require_relative "omq/router_dealer"
 require_relative "omq/pub_sub"
 require_relative "omq/push_pull"
 require_relative "omq/pair"
+
+# For the purists.
+ØMQ = OMQ

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omq
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Patrik Wenger