omq 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e1ab1933600879bdce366be75711129dd5ed1fd24f78026544a53a80db2ea1e
-  data.tar.gz: 89978df5161c8df19c4bdbf485ca3d28a75af4bb83760c0076917585abfc1adc
+  metadata.gz: e18ec192a40dba5a208b0548d7c4f45091a95909ee9a56eb17782bccb85855c7
+  data.tar.gz: 343a94d01152a9f76b8876b2a85f29b4adebaed2dd0fcdee958d01877f9970da
 SHA512:
-  metadata.gz: 817ea2eb9ab32b4300b3e74bfa6d81bb2d7d003ab3986bfe8b1a5cb3caed6cd2fad69c3391f6a091019b637edacbbdb3457ed92d16f7776d0b93b2bc68063289
-  data.tar.gz: c32130ffee59d23d7b82c239212691846fcbc88cb7e5dcda1762e0a21db1d30e789f7368205ce07f3f2dfbf79fab3e799660e54b91c2b5439736617bf9be9507
+  metadata.gz: 581b7119d33deedca75f3dd4d2701a0955ad4b4434d258ce368f1b61f5c25c3b4891e210007f331e0a051043cdf0936f1f1f7d1d9dabc5b25d4d4b79deb823f6
+  data.tar.gz: 999d27f8c87edb499219d3d2927d0d67bea4a6171231e40a251348839343eca17ff9ab335735ec1585e04baa96f0ee5ff3f481128c113bb3a8f03d900f5cbfd0

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 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
+
+- `mechanism` option now holds the mechanism instance directly
+  (`Mechanism::Null.new` by default). For CURVE, use
+  `OMQ::Curve.server(pub, sec)` or `OMQ::Curve.client(pub, sec, server_key: k)`.
+- Removed `curve_server`, `curve_server_key`, `curve_public_key`,
+  `curve_secret_key`, `curve_authenticator` socket options
+
 ## 0.1.1 — 2026-03-26
 
 ### Fixed

data/lib/omq/socket.rb

@@ -31,11 +31,6 @@ module OMQ
       heartbeat_timeout       heartbeat_timeout=
       max_message_size        max_message_size=
       mechanism               mechanism=
-      curve_server            curve_server=
-      curve_server_key        curve_server_key=
-      curve_public_key        curve_public_key=
-      curve_secret_key        curve_secret_key=
-      curve_authenticator     curve_authenticator=
     ].each do |method|
       define_method(method) { |*args| @options.public_send(method, *args) }
     end

data/lib/omq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OMQ
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 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/zmtp/engine.rb

@@ -260,7 +260,7 @@ module OMQ
           socket_type:       @socket_type.to_s,
           identity:          @options.identity,
           as_server:         as_server,
-          mechanism:          build_mechanism,
+          mechanism:          @options.mechanism,
           heartbeat_interval: @options.heartbeat_interval,
           heartbeat_ttl:      @options.heartbeat_ttl,
           heartbeat_timeout:  @options.heartbeat_timeout,
@@ -305,26 +305,6 @@ module OMQ
       end
 
 
-      def build_mechanism
-        case @options.mechanism
-        when :null
-          Mechanism::Null.new
-        when :curve
-          unless defined?(Mechanism::Curve)
-            raise LoadError, "require 'omq/curve' to use CURVE security"
-          end
-          Mechanism::Curve.new(
-            server_key:    @options.curve_server_key,
-            public_key:    @options.curve_public_key,
-            secret_key:    @options.curve_secret_key,
-            as_server:     @options.curve_server,
-            authenticator: @options.curve_authenticator,
-          )
-        else
-          raise ArgumentError, "unknown mechanism: #{@options.mechanism}"
-        end
-      end
-
       def transport_for(endpoint)
         case endpoint
         when /\Atcp:\/\//    then Transport::TCP

data/lib/omq/zmtp/options.rb

@@ -25,12 +25,7 @@ module OMQ
         @heartbeat_ttl         = nil   # seconds, nil = use heartbeat_interval
         @heartbeat_timeout     = nil   # seconds, nil = use heartbeat_interval
         @max_message_size       = nil  # bytes, nil = unlimited
-        @mechanism              = :null # :null or :curve
-        @curve_server           = false
-        @curve_server_key       = nil  # 32-byte binary (server's permanent public key)
-        @curve_public_key       = nil  # 32-byte binary (our permanent public key)
-        @curve_secret_key       = nil  # 32-byte binary (our permanent secret key)
-        @curve_authenticator    = nil  # nil = allow all, Set = allowlist, #call = custom
+        @mechanism              = Mechanism::Null.new
       end
 
       attr_accessor :send_hwm,  :recv_hwm,
@@ -40,10 +35,7 @@ module OMQ
                     :reconnect_interval,
                     :heartbeat_interval,    :heartbeat_ttl,    :heartbeat_timeout,
                     :max_message_size,
-                    :mechanism,
-                    :curve_server,          :curve_server_key,
-                    :curve_public_key,      :curve_secret_key,
-                    :curve_authenticator
+                    :mechanism
 
       alias_method :router_mandatory?, :router_mandatory
       alias_method :recv_timeout,      :read_timeout

metadata

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