protocol-http1 0.25.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad917a8e0aa2f76df0ea21a56a914dc6575d1e22ee13a2b36a60f5a1ca37ed6e
-  data.tar.gz: 2d6adbe2df3cd0c712e381a46adbba85de481ece8ee77ada0cf9a8b0638fc35a
+  metadata.gz: 88bedd2de9b6357ee48174d2a984d5f8cdc391311b0ac13cbd21c4e398d2076b
+  data.tar.gz: 4e631b85f63d21cd5dc4e93a49b014301d4faf42c8f0c04bc4341045a34cffe7
 SHA512:
-  metadata.gz: 5f9b082e5bf6756d18127ad03ba0a2b14568227f859c05d7391983ce2a1157241cf635dcb3bc865264dfb6fb639991650c30b5ad2a8bb56ba1177ee11bce8a05
-  data.tar.gz: a050ed9a0618856e61cfdc8d2e45a268ace98bb97ce6a76ba384480db55abc7fb7c71d113c967b1dfa9e53f5ce56c4469a7559f9eddb41a51c06b168a8b85b7b
+  metadata.gz: 751ca8414f97b9e6a35daf7350e6e5afb5d59bb3c6be1d740aa78c57a838111c49757b0da43f2875899b6b94d050fc0d163dd4a9d449f2f8450a6b219b7a07fc
+  data.tar.gz: 879adf7b92618c4707459c5498f1a8c5567a01c73c466c371f32488820f54b85b17ab92e1259434bf64d4e7b48dcc92d2a6e70eca273a90094ed87773a22c315

data/lib/protocol/http1/connection.rb

@@ -91,8 +91,8 @@ module Protocol
 			# │           ▼            └───┬────┘            ▼
 			# │      ┌──────────┐          │           ┌──────────┐
 			# │      │   half   │          │           │   half   │
-			# │      │  closed  │          │           │  closed  │
-			# │      │ (remote) │          │           │ (local)  │
+			# │      │  closed  │          │ send R /  │  closed  │
+			# │      │ (remote) │          │ recv R    │ (local)  │
 			# │      └────┬─────┘          │           └─────┬────┘
 			# │           │                │                 │
 			# │           │ send ES /      │       recv ES / │
@@ -104,7 +104,8 @@ module Protocol
 			#         persistent       └────────┘
 			# ```
 			#
-			# - `ES`: the body was fully received or sent (end of stream)
+			# - `ES`: the body was fully received or sent (end of stream).
+			# - `R`: the connection was closed unexpectedly (reset).
 			#
 			# State transition methods use a trailing "!".
 			attr_accessor :state
@@ -176,14 +177,16 @@ module Protocol
 			# @return [IO] the underlying non-blocking IO.
 			def hijack!
 				@persistent = false
-				stream = @stream
 				
-				@stream.flush
-				@stream = nil
-				
-				self.closed!
-				
-				return stream
+				if stream = @stream
+					@stream = nil
+					stream.flush
+					
+					@state = :hijacked
+					self.closed
+					
+					return stream
+				end
 			end
 			
 			def close_read
@@ -193,16 +196,28 @@ module Protocol
 			end
 			
 			# Close the connection and underlying stream.
-			def close
+			def close(error = nil)
 				@persistent = false
-				@stream&.close
-				self.closed!
+				
+				if stream = @stream
+					@stream = nil
+					stream.close
+				end
+				
+				unless closed?
+					@state = :closed
+					self.closed(error)
+				end
 			end
 			
 			def open!
-				raise ProtocolError, "Cannot write request in #{@state}!" unless @state == :idle
+				unless @state == :idle
+					raise ProtocolError, "Cannot open connection in state: #{@state}!"
+				end
 				
 				@state = :open
+				
+				return self
 			end
 			
 			def write_request(authority, method, path, version, headers)
@@ -216,7 +231,7 @@ module Protocol
 			
 			def write_response(version, status, headers, reason = Reason::DESCRIPTIONS[status])
 				unless @state == :open or @state == :half_closed_remote
-					raise ProtocolError, "Cannot write response in #{@state}!"
+					raise ProtocolError, "Cannot write response in state: #{@state}!"
 				end
 				
 				# Safari WebSockets break if no reason is given:
@@ -227,7 +242,7 @@ module Protocol
 			
 			def write_interim_response(version, status, headers, reason = Reason::DESCRIPTIONS[status])
 				unless @state == :open or @state == :half_closed_remote
-					raise ProtocolError, "Cannot write interim response in #{@state}!"
+					raise ProtocolError, "Cannot write interim response in state: #{@state}!"
 				end
 				
 				@stream.write("#{version} #{status} #{reason}\r\n")
@@ -321,7 +336,7 @@ module Protocol
 			
 			def read_response(method)
 				unless @state == :open or @state == :half_closed_local
-					raise ProtocolError, "Cannot read response in #{@state}!"
+					raise ProtocolError, "Cannot read response in state: #{@state}!"
 				end
 				
 				version, status, reason = read_response_line
@@ -364,9 +379,9 @@ module Protocol
 				if @state == :open
 					@state = :half_closed_local
 				elsif @state == :half_closed_remote
-					self.closed!
+					self.close!
 				else
-					raise ProtocolError, "Cannot send end stream in #{@state}!"
+					raise ProtocolError, "Cannot send end stream in state: #{@state}!"
 				end
 			end
 			
@@ -518,16 +533,24 @@ module Protocol
 				self.send_end_stream!
 			end
 			
-			def idle!
-				@state = :idle
+			# The connection (stream) was closed. It may now be in the idle state.
+			def closed(error = nil)
 			end
 			
-			def closed!
-				if @persistent
-					self.idle!
+			# Transition to the closed state.
+			#
+			# If no error occurred, and the connection is persistent, this will immediately transition to the idle state.
+			#
+			# @parameter error [Exxception] the error that caused the connection to close.
+			def close!(error = nil)
+				if @persistent and !error
+					# If there was no error, and the connection is persistent, we can reuse it:
+					@state = :idle
 				else
 					@state = :closed
 				end
+				
+				self.closed(error)
 			end
 			
 			def write_body(version, body, head = false, trailer = nil)
@@ -565,9 +588,9 @@ module Protocol
 				if @state == :open
 					@state = :half_closed_remote
 				elsif @state == :half_closed_local
-					self.closed!
+					self.close!
 				else
-					raise ProtocolError, "Cannot receive end stream in #{@state}!"
+					raise ProtocolError, "Cannot receive end stream in state: #{@state}!"
 				end
 			end
 			

data/lib/protocol/http1/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP1
-		VERSION = "0.25.0"
+		VERSION = "0.27.0"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http1
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -42,7 +42,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-09-19 00:00:00.000000000 Z
+date: 2024-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-http