protocol-zmtp 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8774efa1927a863efbec0173b00b4642fe99f809ee0df07e3ab6a164829909e
-  data.tar.gz: a77071e52f4461323f7d839738ad56d0ed83af312ae1071b4f88ffb365ee2514
+  metadata.gz: 0f82192f566af0256273b9dd794ad7032c5b1f3d1b2f8a58c37235847715f6fc
+  data.tar.gz: b74e78954d38be3f239d96cbcac676dc564b9ab56dff16f1beff8fbcedb77b8b
 SHA512:
-  metadata.gz: c0cc5712a1c5aabd5f360ea5fe052bb45e963f645551f0bea2a46f62d3d43d4f9f8a0a0cd3a2de63e563641d2463586b0574016db6ab394a66b78a0c7bd93924
-  data.tar.gz: 87ae97e2a6bc9448b16a9053d959e7b7707639bb15ad168bc020f83eae0d95309b82be6a0772a38d6e56307038de013d7544e836094c5d52b4dfb114175b5a28
+  metadata.gz: 985cc52f11cc1ad7d24bdbec3916ee5485bda72a396413b3735254ae97430117b40ae3fd6331107e953c0b99bc3c05a997c368eeae642e64b023dd3d744381eb
+  data.tar.gz: 100df0f00b447bbc6799c4468b040f15e8fe633bf25d736b44931683772d5f52a50fa2646e8ce3f4768f6076d47482a9a004944f55f42a3d35720ca3f6ede27e

data/lib/protocol/zmtp/connection.rb

@@ -52,6 +52,11 @@ module Protocol
         @mutex            = Mutex.new
         @max_message_size = max_message_size
         @last_received_at = nil
+
+        # Reusable scratch buffer for frame headers. Array#pack(buffer:)
+        # writes in place so the per-message 2-or-9 byte String allocation
+        # in write_frames disappears on the hot send path.
+        @header_buf = String.new(capacity: 9, encoding: Encoding::BINARY)
       end
 
 
@@ -90,9 +95,11 @@ module Protocol
       # @param parts [Array<String>] message frames
       # @return [void]
       def send_message(parts)
-        @mutex.synchronize do
-          write_frames(parts)
-          @io.flush
+        with_deferred_cancel do
+          @mutex.synchronize do
+            write_frames(parts)
+            @io.flush
+          end
         end
       end
 
@@ -103,8 +110,33 @@ module Protocol
       # @param parts [Array<String>] message frames
       # @return [void]
       def write_message(parts)
-        @mutex.synchronize do
-          write_frames(parts)
+        with_deferred_cancel do
+          @mutex.synchronize do
+            write_frames(parts)
+          end
+        end
+      end
+
+
+      # Writes a batch of multi-frame messages to the buffer under a
+      # single mutex acquisition. Used by work-stealing send pumps that
+      # dequeue up to N messages at once — avoids the N lock/unlock
+      # pairs per batch that a plain `batch.each { write_message }`
+      # would incur.
+      #
+      # @param messages [Array<Array<String>>] each element is one
+      #   multi-frame message
+      # @return [void]
+      def write_messages(messages)
+        with_deferred_cancel do
+          @mutex.synchronize do
+            i = 0
+            n = messages.size
+            while i < n
+              write_frames(messages[i])
+              i += 1
+            end
+          end
         end
       end
 
@@ -115,8 +147,10 @@ module Protocol
       # @param wire_bytes [String] ZMTP wire-format bytes
       # @return [void]
       def write_wire(wire_bytes)
-        @mutex.synchronize do
-          @io.write(wire_bytes)
+        with_deferred_cancel do
+          @mutex.synchronize do
+            @io.write(wire_bytes)
+          end
         end
       end
 
@@ -165,13 +199,15 @@ module Protocol
       # @param command [Codec::Command]
       # @return [void]
       def send_command(command)
-        @mutex.synchronize do
-          if @mechanism.encrypted?
-            @io.write(@mechanism.encrypt(command.to_body, command: true))
-          else
-            @io.write(command.to_frame.to_wire)
+        with_deferred_cancel do
+          @mutex.synchronize do
+            if @mechanism.encrypted?
+              @io.write(@mechanism.encrypt(command.to_body, command: true))
+            else
+              @io.write(command.to_frame.to_wire)
+            end
+            @io.flush
           end
-          @io.flush
         end
       end
 
@@ -240,14 +276,53 @@ module Protocol
 
       private
 
+      # Defers task cancellation around a block of wire writes so the
+      # peer never sees a half-written frame. Without this, an
+      # +Async::Cancel+ arriving between the header write and the body
+      # write (the unencrypted path issues two separate +@io.write+
+      # calls per frame) would desync the peer's framer
+      # unrecoverably.
+      #
+      # When called outside an Async task (test fixtures, blocking
+      # callers), the block runs directly -- there is no task to defer
+      # on. Cancellation arriving from inside the block (peer
+      # disconnect raising +EPIPE+/+EOFError+) propagates normally.
+      def with_deferred_cancel
+        if defined?(Async::Task) && (task = Async::Task.current?)
+          task.defer_cancel { yield }
+        else
+          yield
+        end
+      end
+
+
       # Writes message parts as ZMTP frames, encrypting if needed.
+      #
+      # For the unencrypted path, writes the frame header and body
+      # separately to the IO instead of allocating a wire String. This
+      # avoids copying the body just to glue a 1- or 9-byte header onto
+      # it -- significant for large messages where the body copy was
+      # the dominant allocation per send.
       def write_frames(parts)
+        encrypted = @mechanism.encrypted?
+        buf       = @header_buf
+
         parts.each_with_index do |part, i|
           more = i < parts.size - 1
-          if @mechanism.encrypted?
+          if encrypted
             @io.write(@mechanism.encrypt(part.b, more: more))
           else
-            @io.write(Codec::Frame.new(part, more: more).to_wire)
+            body  = part.b
+            size  = body.bytesize
+            flags = more ? Codec::Frame::FLAGS_MORE : 0
+            buf.clear
+            if size > Codec::Frame::SHORT_MAX
+              [flags | Codec::Frame::FLAGS_LONG, size].pack("CQ>", buffer: buf)
+            else
+              [flags, size].pack("CC", buffer: buf)
+            end
+            @io.write(buf)
+            @io.write(body)
           end
         end
       end

data/lib/protocol/zmtp/version.rb

@@ -2,6 +2,6 @@
 
 module Protocol
   module ZMTP
-    VERSION = "0.3.0"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-zmtp
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Patrik Wenger