protocol-zmtp 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81270e34092271f0e0aaceed0ce882885751def59b75716872d074952e4d6b41
-  data.tar.gz: ccbf823376d70d8654384b99c1bb30b270dc9493cd432c524a3caab175eaa364
+  metadata.gz: edfecc19ca6c0befbc5835da0fbfc1fc364007207f10e6f1de64c733d48f2336
+  data.tar.gz: d6616b661ee77e73191ed6f33e0a3c5b73b04e6b3fe8e8e5cac30067ae75bb42
 SHA512:
-  metadata.gz: f148b0ac01768320f35f2edf7ac67f3d51ad3e5daa4a9c9dafccb57168e8e9f616f6f27425c00b82edcd7e0af898188ae37ea3a78f404a786bdd9a94c01cb675
-  data.tar.gz: bdab4d4b763394ea1f11aec4503a74d68f499671c93851adc96c2e34bcd7134de837b71941119a1aa029a0966c4ed4cfea8def3f5140244e50f9c2a9b3b0355d
+  metadata.gz: 4520a2435a1490fcfb7aebd070f58d10e97a05da685a3c36a47417db2e82b8d7ef48d0c5d19ee6c7db99c7b5da552cd4fec2f061aee3fd9e55908d7d30cf301d
+  data.tar.gz: d8c6f26fe3197a25f32e5c5a6668d53eb8cecf109dbe084b00c63b2fcb396cbe05dfd37c9b01ecbc39a960f35ce56ca70fa02c49761e9e0065246ffffeb36437

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

@@ -28,51 +28,6 @@ module Protocol
         FLAG_BYTES = Array.new(256) { |i| i.chr.b.freeze }.freeze
 
 
-        # @return [String] frame body (binary)
-        attr_reader :body
-
-
-        # @param body [String] frame body
-        # @param more [Boolean] more frames follow
-        # @param command [Boolean] this is a command frame
-        def initialize(body, more: false, command: false)
-          @body    = body.encoding == Encoding::BINARY ? body : body.b
-          @more    = more
-          @command = command
-        end
-
-
-        # @return [Boolean] true if more frames follow in this message
-        def more?
-          @more
-        end
-
-
-        # @return [Boolean] true if this is a command frame
-        def command?
-          @command
-        end
-
-
-        # Encodes to wire bytes.
-        #
-        # @return [String] binary wire representation (flags + size + body)
-        def to_wire
-          size  = @body.bytesize
-          flags = 0
-          flags |= FLAGS_MORE if @more
-          flags |= FLAGS_COMMAND if @command
-
-          if size > SHORT_MAX
-            buf = String.new(capacity: 9 + size, encoding: Encoding::BINARY)
-            buf << FLAG_BYTES[flags | FLAGS_LONG] << [size].pack("Q>") << @body
-          else
-            buf = String.new(capacity: 2 + size, encoding: Encoding::BINARY)
-            buf << FLAG_BYTES[flags] << FLAG_BYTES[size] << @body
-          end
-        end
-
-
         # Encodes a multi-part message into a single wire-format string.
         # The result can be written to multiple connections without
         # re-encoding each time (useful for fan-out patterns like PUB).
@@ -82,19 +37,20 @@ module Protocol
         #
         def self.encode_message(parts)
           if parts.size == 1
-            s = parts[0].bytesize
-            wire_size = s > SHORT_MAX ? 9 + s : 2 + s
+            s    = parts.first.bytesize
+            wire = s > SHORT_MAX ? 9 + s : 2 + s
           else
-            wire_size = 0
-            j = 0
+            wire = 0
+            j    = 0
+
             while j < parts.size
-              s = parts[j].bytesize
-              wire_size += s > SHORT_MAX ? 9 + s : 2 + s
-              j += 1
+              s     = parts[j].bytesize
+              wire += s > SHORT_MAX ? 9 + s : 2 + s
+              j    += 1
             end
           end
 
-          buf  = String.new(capacity: wire_size, encoding: Encoding::BINARY)
+          buf  = String.new(capacity: wire, encoding: Encoding::BINARY)
           last = parts.size - 1
           i    = 0
 
@@ -105,10 +61,15 @@ module Protocol
             flags = i < last ? FLAGS_MORE : 0
 
             if size > SHORT_MAX
-              buf << FLAG_BYTES[flags | FLAGS_LONG] << [size].pack("Q>") << body
+              buf << FLAG_BYTES[flags | FLAGS_LONG]
+              buf << [size].pack("Q>")
+              buf << body
             else
-              buf << FLAG_BYTES[flags] << FLAG_BYTES[size] << body
+              buf << FLAG_BYTES[flags]
+              buf << FLAG_BYTES[size]
+              buf << body
             end
+
             i += 1
           end
 
@@ -118,49 +79,107 @@ module Protocol
 
         # Reads one frame from an IO-like object.
         #
-        # @param io [#read_exactly] must support read_exactly(n)
+        # Uses #peek to buffer just enough header bytes (2 for short frames,
+        # 9 for long), then drains header + body in a single #read_exactly.
+        # This is 2 calls for both short and long frames, vs the naive 3 for
+        # long. A speculative read_exactly(9) would be unsafe: a <7-byte
+        # short frame at idle would hang waiting for bytes that never arrive,
+        # or consume bytes from the next frame on a mixed stream.
+        #
+        # @param io [#peek, #read_exactly]
         # @return [Frame]
         # @raise [Error] on invalid frame
         # @raise [EOFError] if the connection is closed
         def self.read_from(io, max_message_size: nil)
-          # Every valid frame has at least 2 header bytes (flags + 1 size
-          # byte for short frames, or flags + first size byte for long).
-          # Fetching both up-front gives short frames a 2-call read path
-          # (header + body) instead of 3.
-          head  = io.read_exactly(2)
-          flags = head.getbyte(0)
+          buf = io.peek do |b|
+            next false if b.bytesize < 2
+            (b.getbyte(0) & FLAGS_LONG) == 0 || b.bytesize >= 9
+          end
+
+          raise EOFError, "Stream finished before reading frame header" if buf.bytesize < 2
 
+          flags   = buf.getbyte(0)
           more    = (flags & FLAGS_MORE) != 0
           long    = (flags & FLAGS_LONG) != 0
           command = (flags & FLAGS_COMMAND) != 0
-          size    = long ? read_long_size(io, head.getbyte(1)) : head.getbyte(1)
+
+          if long
+            raise EOFError, "Stream finished before reading long frame size" if buf.bytesize < 9
+
+            size = (buf.getbyte(1) << 56) |
+                   (buf.getbyte(2) << 48) |
+                   (buf.getbyte(3) << 40) |
+                   (buf.getbyte(4) << 32) |
+                   (buf.getbyte(5) << 24) |
+                   (buf.getbyte(6) << 16) |
+                   (buf.getbyte(7) << 8)  |
+                    buf.getbyte(8)
+            header_size = 9
+          else
+            size        = buf.getbyte(1)
+            header_size = 2
+          end
 
           if max_message_size && size > max_message_size
             raise Error, "frame size #{size} exceeds max_message_size #{max_message_size}"
           end
 
-          body = size > 0 ? io.read_exactly(size) : EMPTY_BINARY
+          if size.zero?
+            io.read_exactly(header_size)
+            return new(EMPTY_BINARY, more: more, command: command)
+          end
 
-          new(body, more: more, command: command)
+          wire = io.read_exactly(header_size + size)
+          new(wire.byteslice(header_size, size), more: more, command: command)
         end
 
 
-        # Reads the remaining 7 bytes of a long frame's 8-byte big-endian
-        # size field and combines them with +msb+ (already consumed as the
-        # second byte of the 2-byte speculative header read).
-        #
-        # @param io [#read_exactly]
-        # @param msb [Integer] first (most-significant) byte of the size
-        # @return [Integer] full 64-bit frame size
+        # @return [String] frame body (binary)
+        attr_reader :body
+
+
+        # @param body [String] frame body
+        # @param more [Boolean] more frames follow
+        # @param command [Boolean] this is a command frame
+        def initialize(body, more: false, command: false)
+          @body    = body.encoding == Encoding::BINARY ? body : body.b
+          @more    = more
+          @command = command
+        end
+
+
+        # @return [Boolean] true if more frames follow in this message
+        def more?
+          @more
+        end
+
+
+        # @return [Boolean] true if this is a command frame
+        def command?
+          @command
+        end
+
+
+        # Encodes to wire bytes.
         #
-        def self.read_long_size(io, msb)
-          rest = io.read_exactly(7)
-
-          (msb << 56) |
-            (rest.getbyte(0) << 48) | (rest.getbyte(1) << 40) |
-            (rest.getbyte(2) << 32) | (rest.getbyte(3) << 24) |
-            (rest.getbyte(4) << 16) | (rest.getbyte(5) << 8)  |
-             rest.getbyte(6)
+        # @return [String] binary wire representation (flags + size + body)
+        def to_wire
+          size   = @body.bytesize
+          flags  = 0
+          flags |= FLAGS_MORE if @more
+          flags |= FLAGS_COMMAND if @command
+
+          if size > SHORT_MAX
+            buf = String.new(capacity: 9 + size, encoding: Encoding::BINARY)
+            buf << FLAG_BYTES[flags | FLAGS_LONG]
+            buf << [size].pack("Q>")
+            buf << @body
+          else
+            buf = String.new(capacity: 2 + size, encoding: Encoding::BINARY)
+            buf << FLAG_BYTES[flags]
+            buf << FLAG_BYTES[size]
+            buf << @body
+          end
         end
 
       end

data/lib/protocol/zmtp/connection.rb

@@ -42,7 +42,7 @@ module Protocol
       attr_reader :peer_minor
 
 
-      # @return [Object] transport IO (#read_exactly, #write, #flush, #close)
+      # @return [Object] transport IO (#peek, #read_exactly, #write, #flush, #close)
       attr_reader :io
 
 
@@ -50,7 +50,7 @@ module Protocol
       attr_reader :last_received_at
 
 
-      # @param io [#read_exactly, #write, #flush, #close] transport IO
+      # @param io [#peek, #read_exactly, #write, #flush, #close] transport IO
       # @param socket_type [String] our socket type name (e.g. "REQ")
       # @param identity [String] our identity
       # @param as_server [Boolean] whether we are the server side

data/lib/protocol/zmtp/version.rb

@@ -2,6 +2,6 @@
 
 module Protocol
   module ZMTP
-    VERSION = "0.8.1"
+    VERSION = "0.9.0"
   end
 end

metadata

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