protocol-http2 0.19.1 → 0.19.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fb7df701ecc5c31e840235686d8bf4a512d07d9ee86683757c674e57f5c45d5
-  data.tar.gz: 76081def8efb7a62eecb61927ccc1bb98add213ba90e57862c38775b1d7be6a8
+  metadata.gz: 1fc681846886564561e01287c0c8ac5db0944222c6f94262894fe50ac1d0d2a5
+  data.tar.gz: 94106491f20c0b6f08fc637ecd46ccab6a38362207f90ddfefb12b02ba901aad
 SHA512:
-  metadata.gz: ef1d366a3b200bee1f997f13b5ec39a6ca033bde01b634737fe246005607ee97bb2c188b7afad8fef8bb991e246b7440bc5e2a805c20d189a94a7fc82b9d83ea
-  data.tar.gz: '03609bab9cbb8825443045dd63b3a7933c77389b1768d18262a8c4dbf3601273f5fe52c3c8fc69a3f3328dcd73ad0d283b0d20fbcaa9bcc81b1fb55a585912bf'
+  metadata.gz: 6bb39e01cf605b16625a81ba6706b37ec9022c220e3200cea4e8136091842532f9a00b47c76980a36e726401f35eaf22522211e2c567322099512f6a1c472278
+  data.tar.gz: e2ca6677a9b488a0ec7d4e74ecf1bfb349e496d2e248c60928c27286cfa99c3a5e07a6edf2b957d797c6f374e2e23b2f2ac362b0458594064acf5d9de856c872

data/lib/protocol/http2/connection.rb

@@ -41,7 +41,7 @@ module Protocol
 				@decoder = HPACK::Context.new
 				@encoder = HPACK::Context.new
 				
-				@local_window = LocalWindow.new()
+				@local_window = LocalWindow.new
 				@remote_window = Window.new
 			end
 			
@@ -215,20 +215,18 @@ module Protocol
 			def write_frame(frame)
 				synchronize do
 					@framer.write_frame(frame)
-					
-					# I tried moving this outside the synchronize block but it caused a deadlock.
-					@framer.flush
 				end
+				
+				@framer.flush
 			end
 			
 			def write_frames
 				if @framer
 					synchronize do
 						yield @framer
-						
-						# See note above.
-						@framer.flush
 					end
+					
+					@framer.flush
 				else
 					raise EOFError, "Connection closed!"
 				end
@@ -476,7 +474,7 @@ module Protocol
 				# Return if there is no window to consume:
 				return unless size > 0
 				
-				# Console.logger.debug(self) do |buffer|
+				# Console.info(self) do |buffer|
 				# 	@dependencies.each do |id, dependency|
 				# 		buffer.puts "- #{dependency}"
 				# 	end

data/lib/protocol/http2/flow_controlled.rb

@@ -70,15 +70,11 @@ module Protocol
 			def receive_window_update(frame)
 				amount = frame.unpack
 				
-				# Async.logger.info(self) {"expanding remote_window=#{@remote_window} by #{amount}"}
-				
 				if amount != 0
 					@remote_window.expand(amount)
 				else
 					raise ProtocolError, "Invalid window size increment: #{amount}!"
 				end
-				
-				# puts "expanded remote_window=#{@remote_window} by #{amount}"
 			end
 			
 			# The window has been expanded by the given amount.

data/lib/protocol/http2/stream.rb

@@ -275,7 +275,7 @@ module Protocol
 			end
 			
 			protected def ignore_headers(frame)
-				# Async.logger.warn(self) {"Received headers in state: #{@state}!"}
+				# Console.warn(self) {"Received headers in state: #{@state}!"}
 			end
 			
 			def receive_headers(frame)
@@ -316,7 +316,7 @@ module Protocol
 			end
 			
 			def ignore_data(frame)
-				# Async.logger.warn(self) {"Received headers in state: #{@state}!"}
+				# Console.warn(self) {"Received headers in state: #{@state}!"}
 			end
 			
 			# DATA frames are subject to flow control and can only be sent when a stream is in the "open" or "half-closed (remote)" state.  The entire DATA frame payload is included in flow control, including the Pad Length and Padding fields if present.  If a DATA frame is received whose stream is not in "open" or "half-closed (local)" state, the recipient MUST respond with a stream error of type STREAM_CLOSED.

data/lib/protocol/http2/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP2
-		VERSION = "0.19.1"
+		VERSION = "0.19.3"
 	end
 end

data/lib/protocol/http2/window.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+module Protocol
+	module HTTP2
+		class Window
+			# When an HTTP/2 connection is first established, new streams are created with an initial flow-control window size of 65,535 octets. The connection flow-control window is also 65,535 octets.
+			DEFAULT_CAPACITY = 0xFFFF
+			
+			# @param capacity [Integer] The initial window size, typically from the settings.
+			def initialize(capacity = DEFAULT_CAPACITY)
+				# This is the main field required:
+				@available = capacity
+				
+				# These two fields are primarily used for efficiently sending window updates:
+				@used = 0
+				@capacity = capacity
+			end
+			
+			# The window is completely full?
+			def full?
+				@available <= 0
+			end
+			
+			attr :used
+			attr :capacity
+			
+			# When the value of SETTINGS_INITIAL_WINDOW_SIZE changes, a receiver MUST adjust the size of all stream flow-control windows that it maintains by the difference between the new value and the old value.
+			def capacity= value
+				difference = value - @capacity
+				
+				# An endpoint MUST treat a change to SETTINGS_INITIAL_WINDOW_SIZE that causes any flow-control window to exceed the maximum size as a connection error of type FLOW_CONTROL_ERROR.
+				if (@available + difference) > MAXIMUM_ALLOWED_WINDOW_SIZE
+					raise FlowControlError, "Changing window size by #{difference} caused overflow: #{@available + difference} > #{MAXIMUM_ALLOWED_WINDOW_SIZE}!"
+				end
+				
+				@available += difference
+				@capacity = value
+			end
+			
+			def consume(amount)
+				@available -= amount
+				@used += amount
+			end
+			
+			attr :available
+			
+			def available?
+				@available > 0
+			end
+			
+			def expand(amount)
+				available = @available + amount
+				
+				if available > MAXIMUM_ALLOWED_WINDOW_SIZE
+					raise FlowControlError, "Expanding window by #{amount} caused overflow: #{available} > #{MAXIMUM_ALLOWED_WINDOW_SIZE}!"
+				end
+				
+				# puts "expand(#{amount}) @available=#{@available}"
+				@available += amount
+				@used -= amount
+			end
+			
+			def wanted
+				@used
+			end
+			
+			def limited?
+				@available < (@capacity / 2)
+			end
+			
+			def inspect
+				"\#<#{self.class} available=#{@available} used=#{@used} capacity=#{@capacity}#{limited? ? " limited" : nil}>"
+			end
+			
+			alias to_s inspect
+		end
+		
+		# This is a window which efficiently maintains a desired capacity.
+		class LocalWindow < Window
+			def initialize(capacity = DEFAULT_CAPACITY, desired: nil)
+				super(capacity)
+				
+				# The desired capacity of the window, may be bigger than the initial capacity.
+				# If that is the case, we will likely send a window update to the remote end to increase the capacity.
+				@desired = desired
+			end
+			
+			# The desired capacity of the window.
+			attr_accessor :desired
+			
+			def wanted
+				if @desired
+					# We must send an update which allows at least @desired bytes to be sent.
+					(@desired - @capacity) + @used
+				else
+					super
+				end
+			end
+			
+			def limited?
+				if @desired
+					# Do not send window updates until we are less than half the desired capacity:
+					@available < (@desired / 2)
+				else
+					super
+				end
+			end
+			
+			def inspect
+				"\#<#{self.class} available=#{@available} used=#{@used} capacity=#{@capacity} desired=#{@desired} #{limited? ? "limited" : nil}>"
+			end
+		end
+	end
+end

data/lib/protocol/http2/window_update_frame.rb

@@ -4,105 +4,10 @@
 # Copyright, 2019-2024, by Samuel Williams.
 
 require_relative "frame"
+require_relative "window"
 
 module Protocol
 	module HTTP2
-		class Window
-			# @param capacity [Integer] The initial window size, typically from the settings.
-			def initialize(capacity = 0xFFFF)
-				# This is the main field required:
-				@available = capacity
-				
-				# These two fields are primarily used for efficiently sending window updates:
-				@used = 0
-				@capacity = capacity
-			end
-			
-			# The window is completely full?
-			def full?
-				@available <= 0
-			end
-			
-			attr :used
-			attr :capacity
-			
-			# When the value of SETTINGS_INITIAL_WINDOW_SIZE changes, a receiver MUST adjust the size of all stream flow-control windows that it maintains by the difference between the new value and the old value.
-			def capacity= value
-				difference = value - @capacity
-				
-				# An endpoint MUST treat a change to SETTINGS_INITIAL_WINDOW_SIZE that causes any flow-control window to exceed the maximum size as a connection error of type FLOW_CONTROL_ERROR.
-				if (@available + difference) > MAXIMUM_ALLOWED_WINDOW_SIZE
-					raise FlowControlError, "Changing window size by #{difference} caused overflow: #{@available + difference} > #{MAXIMUM_ALLOWED_WINDOW_SIZE}!"
-				end
-				
-				@available += difference
-				@capacity = value
-			end
-			
-			def consume(amount)
-				@available -= amount
-				@used += amount
-			end
-			
-			attr :available
-			
-			def available?
-				@available > 0
-			end
-			
-			def expand(amount)
-				available = @available + amount
-				
-				if available > MAXIMUM_ALLOWED_WINDOW_SIZE
-					raise FlowControlError, "Expanding window by #{amount} caused overflow: #{available} > #{MAXIMUM_ALLOWED_WINDOW_SIZE}!"
-				end
-				
-				# puts "expand(#{amount}) @available=#{@available}"
-				@available += amount
-				@used -= amount
-			end
-			
-			def wanted
-				@used
-			end
-			
-			def limited?
-				@available < (@capacity / 2)
-			end
-			
-			def inspect
-				"\#<#{self.class} used=#{@used} available=#{@available} capacity=#{@capacity}>"
-			end
-		end
-		
-		# This is a window which efficiently maintains a desired capacity.
-		class LocalWindow < Window
-			def initialize(capacity = 0xFFFF, desired: nil)
-				super(capacity)
-				
-				@desired = desired
-			end
-			
-			attr_accessor :desired
-			
-			def wanted
-				if @desired
-					# We must send an update which allows at least @desired bytes to be sent.
-					(@desired - @capacity) + @used
-				else
-					@used
-				end
-			end
-			
-			def limited?
-				if @desired
-					@available < @desired
-				else
-					super
-				end
-			end
-		end
-		
 		# The WINDOW_UPDATE frame is used to implement flow control.
 		#
 		# +-+-------------------------------------------------------------+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http2
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.19.3
 platform: ruby
 authors:
 - Samuel Williams
@@ -40,7 +40,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-09-24 00:00:00.000000000 Z
+date: 2024-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-hpack
@@ -97,6 +97,7 @@ files:
 - lib/protocol/http2/settings_frame.rb
 - lib/protocol/http2/stream.rb
 - lib/protocol/http2/version.rb
+- lib/protocol/http2/window.rb
 - lib/protocol/http2/window_update_frame.rb
 - license.md
 - readme.md