protocol-zmtp 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6f3ddb84f7c69bf776e615da15797cb815eaf663f357cf16cff60c744153bc8
-  data.tar.gz: fd410e2dc417e623254be530230e88fc3e428f62413d6465ee88465c82444b10
+  metadata.gz: a29e580def88791398cee267152d16bd7e187a518bd409f2e8a2acb1e364cab1
+  data.tar.gz: a27e2d1335fe8e0376abf7d17e3b9e4ed2d82e3c98d9dd70733327d789144576
 SHA512:
-  metadata.gz: 0c84020c35c81c9b9609541019cb7433956bfed7a2bf8fd4ea615ad7560b9aecec5086efbab733576309ff7cb2febb4f5c98bef2388f55a056bcf38c78a0633d
-  data.tar.gz: 7251f30d057e56f97e6ffa3eb95af5727d7763a04829b3c93580e36998b1aa2591cdc0152ff4d53e7764ea80f75113585513d537147c3de238b498d50f25d15c
+  metadata.gz: 92318c07232337b3b108e5a98b4735c293e15810a8b41b7d1abe046f7f0ec7ed602072a91baa2ba6a6394ab05a4d260768e01a4302652ac96ca9ed61c9ad621d
+  data.tar.gz: 5e5fe073b34866af67c8b0e820afb95d37b2404cab2a986b26da24d70bb30fa809afef47a27c303b396f83a3f94c3f29da9e9a95f54f4413f83605b9d5fef8b1

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

@@ -23,11 +23,13 @@ module Protocol
         # @return [String] command data (binary)
         attr_reader :data
 
+        EMPTY_DATA = "".b.freeze
+
         # @param name [String] command name
         # @param data [String] command data
-        def initialize(name, data = "".b)
+        def initialize(name, data = EMPTY_DATA)
           @name = name
-          @data = data.b
+          @data = data.encoding == Encoding::BINARY ? data : data.b
         end
 
 
@@ -35,8 +37,9 @@ module Protocol
         #
         # @return [String] binary body (name-length + name + data)
         def to_body
-          name_bytes = @name.b
-          name_bytes.bytesize.chr.b + name_bytes + @data
+          name_bytes = @name.encoding == Encoding::BINARY ? @name : @name.b
+          buf = String.new(capacity: 1 + name_bytes.bytesize + @data.bytesize, encoding: Encoding::BINARY)
+          buf << Frame::FLAG_BYTES[name_bytes.bytesize] << name_bytes << @data
         end
 
 

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

@@ -19,6 +19,12 @@ module Protocol
         # Short frame: 1-byte size, max body 255 bytes.
         SHORT_MAX = 255
 
+        # Pre-computed single-byte flag strings (avoids Integer#chr + String#b per frame).
+        FLAG_BYTES = Array.new(256) { |i| i.chr.b.freeze }.freeze
+
+        # Frozen empty binary string for zero-length frame bodies.
+        EMPTY_BODY = "".b.freeze
+
 
         # @return [String] frame body (binary)
         attr_reader :body
@@ -49,9 +55,9 @@ module Protocol
           flags |= FLAGS_COMMAND if @command
 
           if size > SHORT_MAX
-            (flags | FLAGS_LONG).chr.b + [size].pack("Q>") + @body
+            FLAG_BYTES[flags | FLAGS_LONG] + [size].pack("Q>") + @body
           else
-            flags.chr.b + size.chr.b + @body
+            FLAG_BYTES[flags] + FLAG_BYTES[size] + @body
           end
         end
 
@@ -64,9 +70,20 @@ module Protocol
         # @return [String] frozen binary wire representation
         #
         def self.encode_message(parts)
-          buf = +""
-          parts.each_with_index do |part, i|
-            buf << new(part, more: i < parts.size - 1).to_wire
+          buf  = String.new(encoding: Encoding::BINARY)
+          last = parts.size - 1
+          i    = 0
+          while i < parts.size
+            body  = parts[i]
+            body  = body.b unless body.encoding == Encoding::BINARY
+            size  = body.bytesize
+            flags = i < last ? FLAGS_MORE : 0
+            if size > SHORT_MAX
+              buf << FLAG_BYTES[flags | FLAGS_LONG] << [size].pack("Q>") << body
+            else
+              buf << FLAG_BYTES[flags] << FLAG_BYTES[size] << body
+            end
+            i += 1
           end
           buf.freeze
         end
@@ -95,7 +112,7 @@ module Protocol
             raise Error, "frame size #{size} exceeds max_message_size #{max_message_size}"
           end
 
-          body = size > 0 ? io.read_exactly(size) : "".b
+          body = size > 0 ? io.read_exactly(size) : EMPTY_BODY
 
           new(body, more: more, command: command)
         end

data/lib/protocol/zmtp/connection.rb

@@ -95,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
 
@@ -108,8 +110,10 @@ 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
 
@@ -124,12 +128,14 @@ module Protocol
       #   multi-frame message
       # @return [void]
       def write_messages(messages)
-        @mutex.synchronize do
-          i = 0
-          n = messages.size
-          while i < n
-            write_frames(messages[i])
-            i += 1
+        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
@@ -141,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
 
@@ -191,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
 
@@ -266,6 +276,26 @@ 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
@@ -276,13 +306,17 @@ module Protocol
       def write_frames(parts)
         encrypted = @mechanism.encrypted?
         buf       = @header_buf
+        last      = parts.size - 1
 
-        parts.each_with_index do |part, i|
-          more = i < parts.size - 1
+        i = 0
+        while i < parts.size
+          part = parts[i]
+          more = i < last
           if encrypted
-            @io.write(@mechanism.encrypt(part.b, more: more))
+            body = part.encoding == Encoding::BINARY ? part : part.b
+            @io.write(@mechanism.encrypt(body, more: more))
           else
-            body  = part.b
+            body  = part.encoding == Encoding::BINARY ? part : part.b
             size  = body.bytesize
             flags = more ? Codec::Frame::FLAGS_MORE : 0
             buf.clear
@@ -294,6 +328,7 @@ module Protocol
             @io.write(buf)
             @io.write(body)
           end
+          i += 1
         end
       end
     end

data/lib/protocol/zmtp/version.rb

@@ -2,6 +2,6 @@
 
 module Protocol
   module ZMTP
-    VERSION = "0.4.0"
+    VERSION = "0.5.1"
   end
 end

metadata

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