omq 0.19.0 → 0.19.3

data/lib/omq/routing/pull.rb

@@ -6,6 +6,8 @@ module OMQ
     #
     class Pull
       include FairRecv
+
+
       # @param engine [Engine]
       #
       def initialize(engine)
@@ -19,6 +21,7 @@ module OMQ
       #
       attr_reader :recv_queue
 
+
       # @param connection [Connection]
       #
       def connection_added(connection)
@@ -49,6 +52,7 @@ module OMQ
         @tasks.each(&:stop)
         @tasks.clear
       end
+
     end
   end
 end

data/lib/omq/routing/push.rb

@@ -7,6 +7,7 @@ module OMQ
     class Push
       include RoundRobin
 
+
       # @param engine [Engine]
       #
       def initialize(engine)
@@ -16,13 +17,23 @@ module OMQ
       end
 
 
-      # PUSH is write-only.
+      # PUSH is write-only. Engine-facing recv contract: dequeue raises,
+      # unblock is a no-op (fatal-error propagation still calls it).
       #
       def recv_queue
         raise "PUSH sockets cannot receive"
       end
 
 
+      def dequeue_recv
+        raise "PUSH sockets cannot receive"
+      end
+
+
+      def unblock_recv
+      end
+
+
       # @param connection [Connection]
       #
       def connection_added(connection)
@@ -53,6 +64,7 @@ module OMQ
         @tasks.clear
       end
 
+
       private
 
 
@@ -66,6 +78,7 @@ module OMQ
           conn.receive_message # blocks until peer disconnects; then exits
         end
       end
+
     end
   end
 end

data/lib/omq/routing/rep.rb

@@ -14,6 +14,11 @@ module OMQ
       EMPTY_FRAME = "".b.freeze
 
 
+      # @return [FairQueue]
+      #
+      attr_reader :recv_queue
+
+
       # @param engine [Engine]
       #
       def initialize(engine)
@@ -26,17 +31,14 @@ module OMQ
       end
 
 
-      # @return [FairQueue]
-      #
-      attr_reader :recv_queue
-
       # @param connection [Connection]
       #
       def connection_added(connection)
         add_fair_recv_connection(connection) do |msg|
-          delimiter = msg.index(&:empty?) || msg.size
+          delimiter = msg.index { |p| p.empty? } || msg.size
           envelope  = msg[0, delimiter]
           body      = msg[(delimiter + 1)..] || []
+
           @pending_replies << { conn: connection, envelope: envelope }
           body
         end

data/lib/omq/routing/req.rb

@@ -14,6 +14,11 @@ module OMQ
       EMPTY_BINARY = ::Protocol::ZMTP::Codec::EMPTY_BINARY
 
 
+      # @return [FairQueue]
+      #
+      attr_reader :recv_queue
+
+
       # @param engine [Engine]
       #
       def initialize(engine)
@@ -25,11 +30,6 @@ module OMQ
       end
 
 
-      # @return [FairQueue]
-      #
-      attr_reader :recv_queue
-
-
       # @param connection [Connection]
       #
       def connection_added(connection)

data/lib/omq/routing/round_robin.rb

@@ -19,6 +19,9 @@ module OMQ
     # their #initialize.
     #
     module RoundRobin
+      BATCH_MSG_CAP  = 256
+      BATCH_BYTE_CAP = 512 * 1024
+
       # @return [Boolean] true when the shared send queue is empty
       #   and no pump fiber is mid-write with a dequeued batch.
       #
@@ -26,8 +29,10 @@ module OMQ
         @send_queue.empty? && @in_flight == 0
       end
 
+
       private
 
+
       # Initializes the shared send queue for the including class.
       #
       # @param engine [Engine]
@@ -83,6 +88,7 @@ module OMQ
       #
       def enqueue_round_robin(parts)
         pipe = @direct_pipe
+
         if pipe&.direct_recv_queue
           pipe.send_message(transform_send(parts))
         else
@@ -97,7 +103,9 @@ module OMQ
       # @param parts [Array<String>]
       # @return [Array<String>]
       #
-      def transform_send(parts) = parts
+      def transform_send(parts)
+        parts
+      end
 
 
       # Spawns a send pump for one connection. Drains the shared send
@@ -129,34 +137,47 @@ module OMQ
             batch = [@send_queue.dequeue]
             drain_send_queue_capped(batch)
             @in_flight += batch.size
+
             begin
               write_batch(conn, batch)
             ensure
               @in_flight -= batch.size
             end
-            batch.each { |parts| @engine.emit_verbose_msg_sent(conn, parts) }
+
+            batch.each do |parts|
+              @engine.emit_verbose_msg_sent(conn, parts)
+            end
+
             Async::Task.current.yield
           end
         end
+
         @conn_send_tasks[conn] = task
         @tasks << task
       end
 
 
-      BATCH_MSG_CAP  = 256
-      BATCH_BYTE_CAP = 512 * 1024
-
       def drain_send_queue_capped(batch)
-        bytes = batch[0].sum(&:bytesize)
+        bytes = batch_bytes(batch[0])
         while batch.size < BATCH_MSG_CAP && bytes < BATCH_BYTE_CAP
           msg = @send_queue.dequeue(timeout: 0)
           break unless msg
           batch << msg
-          bytes += msg.sum(&:bytesize)
+          bytes += batch_bytes(msg)
         end
       end
 
 
+      # Byte accounting for send-queue batching. Connection wrappers
+      # (e.g. OMQ::Ractor's MarshalConnection) may enqueue non-string
+      # parts that get transformed at write time — skip those for the
+      # fairness cap rather than crashing on #bytesize.
+      #
+      def batch_bytes(parts)
+        parts.sum { |p| p.respond_to?(:bytesize) ? p.bytesize : 0 }
+      end
+
+
       def write_batch(conn, batch)
         if batch.size == 1
           conn.send_message(transform_send(batch[0]))
@@ -165,6 +186,7 @@ module OMQ
           conn.flush
         end
       end
+
     end
   end
 end

data/lib/omq/routing/router.rb

@@ -12,6 +12,13 @@ module OMQ
     #
     class Router
       include FairRecv
+
+
+      # @return [FairQueue]
+      #
+      attr_reader :recv_queue
+
+
       # @param engine [Engine]
       #
       def initialize(engine)
@@ -25,10 +32,6 @@ module OMQ
       end
 
 
-      # @return [FairQueue]
-      #
-      attr_reader :recv_queue
-
       # @param connection [Connection]
       #
       def connection_added(connection)

data/lib/omq/routing/sub.rb

@@ -8,6 +8,11 @@ module OMQ
     #
     class Sub
 
+      # @return [FairQueue]
+      #
+      attr_reader :recv_queue
+
+
       # @param engine [Engine]
       #
       def initialize(engine)
@@ -19,9 +24,17 @@ module OMQ
       end
 
 
-      # @return [FairQueue]
+      # Engine-facing recv contract. Delegates to the FairQueue.
       #
-      attr_reader :recv_queue
+      def dequeue_recv
+        @recv_queue.dequeue
+      end
+
+
+      def unblock_recv
+        @recv_queue.push(nil)
+      end
+
 
       # @param connection [Connection]
       #
@@ -85,6 +98,7 @@ module OMQ
         @tasks.each(&:stop)
         @tasks.clear
       end
+
     end
   end
 end

data/lib/omq/routing/xpub.rb

@@ -14,6 +14,11 @@ module OMQ
     class XPub
       include FanOut
 
+      # @return [Async::LimitedQueue]
+      #
+      attr_reader :recv_queue
+
+
       # @param engine [Engine]
       #
       def initialize(engine)
@@ -24,9 +29,17 @@ module OMQ
       end
 
 
-      # @return [Async::LimitedQueue]
+      # Engine-facing recv contract. Delegates to the bounded queue.
       #
-      attr_reader :recv_queue
+      def dequeue_recv
+        @recv_queue.dequeue
+      end
+
+
+      def unblock_recv
+        @recv_queue.push(nil)
+      end
+
 
       # @param connection [Connection]
       #
@@ -63,8 +76,10 @@ module OMQ
         @tasks.clear
       end
 
+
       private
 
+
       # Expose subscription to application as data message.
       #
       def on_subscribe(conn, prefix)
@@ -79,6 +94,7 @@ module OMQ
         super
         @recv_queue.enqueue(["\x00#{prefix}".b])
       end
+
     end
   end
 end

data/lib/omq/routing/xsub.rb

@@ -10,6 +10,11 @@ module OMQ
     #
     class XSub
 
+      # @return [FairQueue]
+      #
+      attr_reader :recv_queue
+
+
       # @param engine [Engine]
       #
       def initialize(engine)
@@ -22,9 +27,17 @@ module OMQ
       end
 
 
-      # @return [FairQueue]
+      # Engine-facing recv contract. Delegates to the FairQueue.
       #
-      attr_reader :recv_queue
+      def dequeue_recv
+        @recv_queue.dequeue
+      end
+
+
+      def unblock_recv
+        @recv_queue.push(nil)
+      end
+
 
       # @param connection [Connection]
       #
@@ -58,7 +71,9 @@ module OMQ
       # @param parts [Array<String>]
       #
       def enqueue(parts)
-        @connections.each { |conn| @conn_queues[conn]&.enqueue(parts) }
+        @connections.each do |conn|
+          @conn_queues[conn]&.enqueue(parts)
+        end
       end
 
 
@@ -78,16 +93,21 @@ module OMQ
         @conn_queues.values.all?(&:empty?)
       end
 
+
       private
 
+
       def start_conn_send_pump(conn, q)
         task = @engine.spawn_conn_pump_task(conn, annotation: "send pump") do
           loop do
             parts = q.dequeue
             frame = parts.first&.b
+
             next if frame.nil? || frame.empty?
+
             flag   = frame.getbyte(0)
             prefix = frame.byteslice(1..) || "".b
+
             case flag
             when 0x01
               conn.send_command(Protocol::ZMTP::Codec::Command.subscribe(prefix))
@@ -96,9 +116,11 @@ module OMQ
             end
           end
         end
+
         @conn_send_tasks[conn] = task
         @tasks << task
       end
+
     end
   end
 end

data/lib/omq/routing.rb

@@ -110,5 +110,6 @@ module OMQ
         @registry[socket_type] or raise ArgumentError, "unknown socket type: #{socket_type.inspect}"
       end
     end
+
   end
 end

data/lib/omq/single_frame.rb

@@ -19,5 +19,6 @@ module OMQ
       end
       super
     end
+
   end
 end

data/lib/omq/socket.rb

@@ -6,6 +6,30 @@ module OMQ
   # Socket base class.
   #
   class Socket
+    extend Forwardable
+
+    # Creates a new socket and binds it to the given endpoint.
+    #
+    # @param endpoint [String]
+    # @param opts [Hash] keyword arguments forwarded to {#initialize}
+    # @return [Socket]
+    #
+    def self.bind(endpoint, **opts)
+      new("@#{endpoint}", **opts)
+    end
+
+
+    # Creates a new socket and connects it to the given endpoint.
+    #
+    # @param endpoint [String]
+    # @param opts [Hash] keyword arguments forwarded to {#initialize}
+    # @return [Socket]
+    #
+    def self.connect(endpoint, **opts)
+      new(">#{endpoint}", **opts)
+    end
+
+
     # @return [Options]
     #
     attr_reader :options
@@ -16,10 +40,15 @@ module OMQ
     attr_reader :last_tcp_port
 
 
-    # Delegate socket option accessors to @options.
+    # @return [Engine] the socket's engine. Exposed for peer tooling
+    #   (omq-cli, omq-ffi, omq-ractor) that needs to reach into the
+    #   socket's internals — not part of the stable user API.
     #
-    extend Forwardable
+    attr_reader :engine
 
+
+    # Delegate socket option accessors to @options.
+    #
     def_delegators :@options,
       :send_hwm,              :send_hwm=,
       :recv_hwm,              :recv_hwm=,
@@ -42,28 +71,6 @@ module OMQ
       :mechanism,             :mechanism=
 
 
-    # Creates a new socket and binds it to the given endpoint.
-    #
-    # @param endpoint [String]
-    # @param opts [Hash] keyword arguments forwarded to {#initialize}
-    # @return [Socket]
-    #
-    def self.bind(endpoint, **opts)
-      new("@#{endpoint}", **opts)
-    end
-
-
-    # Creates a new socket and connects it to the given endpoint.
-    #
-    # @param endpoint [String]
-    # @param opts [Hash] keyword arguments forwarded to {#initialize}
-    # @return [Socket]
-    #
-    def self.connect(endpoint, **opts)
-      new(">#{endpoint}", **opts)
-    end
-
-
     # @param endpoints [String, nil] optional endpoint with prefix convention
     #   (+@+ for bind, +>+ for connect, plain uses subclass default)
     # @param linger [Integer] linger period in seconds (default 0)
@@ -134,19 +141,27 @@ module OMQ
 
 
     # @return [Async::Promise] resolves when first peer completes handshake
-    def peer_connected   = @engine.peer_connected
+    def peer_connected
+      @engine.peer_connected
+    end
 
 
     # @return [Async::Promise] resolves when first subscriber joins (PUB/XPUB only)
-    def subscriber_joined = @engine.routing.subscriber_joined
+    def subscriber_joined
+      @engine.routing.subscriber_joined
+    end
 
 
     # @return [Async::Promise] resolves when all peers disconnect (after having had peers)
-    def all_peers_gone   = @engine.all_peers_gone
+    def all_peers_gone
+      @engine.all_peers_gone
+    end
 
 
     # @return [Integer] current number of peer connections
-    def connection_count = @engine.connections.size
+    def connection_count
+      @engine.connections.size
+    end
 
 
     # Signals end-of-stream on the receive side. A subsequent
@@ -263,6 +278,7 @@ module OMQ
     #
     def attach_endpoints(endpoints, default:)
       return unless endpoints
+
       case endpoints
       when /\A@(.+)\z/
         bind($1)
@@ -311,5 +327,6 @@ module OMQ
     def ensure_parent_task(parent: nil)
       @engine.capture_parent_task(parent: parent)
     end
+
   end
 end

data/lib/omq/transport/inproc/direct_pipe.rb

@@ -110,14 +110,18 @@ module OMQ
 
         # @return [Boolean] always false; inproc pipes are never encrypted
         #
-        def encrypted? = false
+        def encrypted?
+          false
+        end
 
 
         # No-op — inproc has no IO buffer to flush.
         #
         # @return [nil]
         #
-        def flush = nil
+        def flush
+          nil
+        end
 
 
         # Receives a multi-frame message.

data/lib/omq/transport/tcp.rb

@@ -210,6 +210,7 @@ module OMQ
           @tasks.each(&:stop)
           @servers.each { |s| s.close rescue nil }
         end
+
       end
     end
   end

data/lib/omq/version.rb

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

data/lib/omq/writable.rb

@@ -7,6 +7,11 @@ module OMQ
   #
   module Writable
     include QueueWritable
+
+
+    EMPTY_PART = "".b.freeze
+
+
     # Sends a message.
     #
     # @param message [String, Array<String>] message parts
@@ -33,8 +38,20 @@ module OMQ
       send(message)
     end
 
+
+    # Waits until the socket is writable.
+    #
+    # @param timeout [Numeric, nil] timeout in seconds
+    # @return [true]
+    #
+    def wait_writable(timeout = @options.write_timeout)
+      true
+    end
+
+
     private
 
+
     # Converts a message into a frozen array of frozen binary strings.
     #
     # @param message [String, Array<String>]
@@ -44,21 +61,23 @@ module OMQ
       parts = message.is_a?(Array) ? message : [message]
       raise ArgumentError, "message has no parts" if parts.empty?
 
-      # Fast path: skip map when all parts are already frozen binary.
+      all_ready = parts.all? { |p| p.is_a?(String) && p.frozen? && p.encoding == Encoding::BINARY }
+
+      # Already a frozen array of frozen binary strings → return as-is.
+      return parts if all_ready && parts.frozen?
+
+      # Items are ready; just freeze the outer array.
+      return parts.freeze if all_ready
+
+      # Items need conversion. Mutate in place when we can.
       if parts.frozen?
-        return parts if parts.all? { |p| p.is_a?(String) && p.frozen? && p.encoding == Encoding::BINARY }
-        parts = parts.map { |p| frozen_binary(p) }
+        parts.map { |p| frozen_binary(p) }.freeze
       else
-        unless parts.all? { |p| p.is_a?(String) && p.frozen? && p.encoding == Encoding::BINARY }
-          parts.map! { |p| frozen_binary(p) }
-        end
+        parts.map! { |p| frozen_binary(p) }.freeze
       end
-      parts.freeze
     end
 
 
-    EMPTY_PART = "".b.freeze
-
     def frozen_binary(obj)
       return EMPTY_PART if obj.nil?
       s = obj.to_s
@@ -66,15 +85,5 @@ module OMQ
       s.b.freeze
     end
 
-    public
-
-    # Waits until the socket is writable.
-    #
-    # @param timeout [Numeric, nil] timeout in seconds
-    # @return [true]
-    #
-    def wait_writable(timeout = @options.write_timeout)
-      true
-    end
   end
 end

metadata

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