omq 0.26.2 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2c1793056ec0f8ed585034cf19a939a7bb22278d865dc9f570a2117e1bd45d4
-  data.tar.gz: b8502a9780715a9e565b52b987ad1a698c07ff76c08c1a6e38f01b833b724f71
+  metadata.gz: 304adcf07ab3967251a821578bb96376b7c080e2a4d0d16430768ba6855b3557
+  data.tar.gz: 26babe478d3f2f07f8d011b2484083bc1c327a9938eaae0ab199bcdc560eaf55
 SHA512:
-  metadata.gz: f3cbc43a10f74f0c1a872071871b9d5daddae41f2304823f8b57388a5c0c99cfb52e9a4118d9504c462d609af759c86a290d3235867fa5d22d46b9ffda63203c
-  data.tar.gz: 44ca650e5c321a56fd4649cbebe0a4bd60efc3127547a5da0010582ed0fbb42fe4bcbf705ddfbf44596266a1d37869d49d4bef03df08551b703091d733b4e10f
+  metadata.gz: 873f2817de7d8fb063da6b425982493012b4eff08b3035cf86fbce948e3398de34ca319713dc4b1f56e4556250a82b23510a304e5f3a503aa01b367c5e6c6379
+  data.tar.gz: 18df1029acefe76806a1e188e077aad0023ec52a5ae63b31aac09fbe450aec68c4c4688b88b8ae77c19669a30f53c418b65f9a728eb377562a5c74da34e1a8fd

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.27.0 — 2026-04-20
+
+### Added
+
+- **Transport-supplied ZMTP Connection class.** Transport modules may
+  now define `.connection_class` to substitute their own
+  `Protocol::ZMTP::Connection`-shaped class. `ConnectionLifecycle`
+  reads it (with a `respond_to?` fallback to
+  `Protocol::ZMTP::Connection`) so existing transports — built-in or
+  third-party — keep working unchanged. Enables plugin transports
+  whose wire shape differs from ZMTP/3.1 (e.g. ZeroMQ-over-WebSocket
+  per RFC 45) to plug in without forking the engine.
+
 ## 0.26.2 — 2026-04-20
 
 ### Fixed

data/lib/omq/engine/connection_lifecycle.rb

@@ -66,13 +66,19 @@ module OMQ
       # @param engine [Engine]
       # @param endpoint [String, nil]
       # @param done [Async::Promise, nil] resolved when connection is lost
+      # @param transport [Module, nil] transport module that produced +io+;
+      #   queried for {.connection_class} so plugins (e.g. WebSocket) can
+      #   substitute their own ZMTP-shaped connection class. Falls back to
+      #   {Protocol::ZMTP::Connection} when nil or when the transport
+      #   doesn't define +connection_class+.
       #
-      def initialize(engine, endpoint: nil, done: nil)
-        @engine   = engine
-        @endpoint = endpoint
-        @done     = done
-        @state    = :new
-        @conn     = nil
+      def initialize(engine, endpoint: nil, done: nil, transport: nil)
+        @engine    = engine
+        @endpoint  = endpoint
+        @done      = done
+        @transport = transport
+        @state     = :new
+        @conn      = nil
 
         # Nest the per-connection barrier under the socket-level barrier
         # so every pump spawned via +@barrier.async+ is also tracked by
@@ -90,7 +96,8 @@ module OMQ
       #
       def handshake!(io, as_server:)
         transition!(:handshaking)
-        conn = Protocol::ZMTP::Connection.new io,
+        conn_class = @transport.respond_to?(:connection_class) ? @transport.connection_class : Protocol::ZMTP::Connection
+        conn = conn_class.new io,
           socket_type:      @engine.socket_type.to_s,
           identity:         @engine.options.identity,
           as_server:        as_server,

data/lib/omq/engine.rb

@@ -635,7 +635,8 @@ module OMQ
     def spawn_connection(io, as_server:, endpoint: nil)
       @lifecycle.barrier&.async(transient: true, annotation: "conn #{endpoint}") do
         done      = Async::Promise.new
-        lifecycle = ConnectionLifecycle.new(self, endpoint: endpoint, done: done)
+        transport = endpoint ? transport_for(endpoint) : nil
+        lifecycle = ConnectionLifecycle.new(self, endpoint: endpoint, done: done, transport: transport)
         lifecycle.handshake!(io, as_server: as_server)
         done.wait
       rescue Async::Stop, Async::Cancel

data/lib/omq/transport/ipc.rb

@@ -15,6 +15,15 @@ module OMQ
 
 
       class << self
+        # ZMTP connection class used for IPC-accepted/dialed peers.
+        #
+        # @return [Class]
+        #
+        def connection_class
+          Protocol::ZMTP::Connection
+        end
+
+
         # Creates a bound IPC listener.
         #
         # @param endpoint [String] e.g. "ipc:///tmp/my.sock" or "ipc://@abstract"

data/lib/omq/transport/tcp.rb

@@ -13,6 +13,15 @@ module OMQ
 
 
       class << self
+        # ZMTP connection class used for TCP-accepted/dialed peers.
+        #
+        # @return [Class]
+        #
+        def connection_class
+          Protocol::ZMTP::Connection
+        end
+
+
         # Creates a bound TCP listener.
         #
         # @param endpoint [String] e.g. "tcp://127.0.0.1:5555" or "tcp://*:0"

data/lib/omq/version.rb

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

metadata

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