protocol-http2 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59f70b2d8905a24deb2b5f6400347631c226dea2814f23a0701d64ca343c8e7e
-  data.tar.gz: b6370e82f47701f4eb7ad21049524cf559d7c1303a839a802a88dfc8f2808c16
+  metadata.gz: 8d2e544f1541f928ab172ef078d2a6ef3350bef0db9e1bbd40d3fb3755501e7f
+  data.tar.gz: a161a66c0f62eb669d9527dee36753b2e63a653aa9e242ed554916d140f8cd65
 SHA512:
-  metadata.gz: f2c32cb5174ed643a415b836a2faa53a325a5e3252e1db55be9fafbc117fd78beb3768b467879f27b146da001caf3a92c74137924e5cf4c9eb86006b7d5a4a42
-  data.tar.gz: 05a417ab4821acb8e0db930440f8a7583ae265f1dd14363eea42963cc4fb313e413aa91d3c81ca4453a413f5db42ef6934e6c4d76cef5f9ac7b757f5f7c6a67e
+  metadata.gz: 7d2bfcf4a4d488978283147d468c1a2afc6aecc94043e626a555e154d4e826e38c79a76092b9c13cc2aad9c3e7d75fc9c9ccae45fdcbbb6d29610bb1630bab0e
+  data.tar.gz: b638a3348b28f9491958a5748dc884b34d2129248744832858fcd1368bad55cfe0da4d18540632414820383dff53c7cb746a69a95e5a5a39423d6f7af00a948f

data/lib/protocol/http2/client.rb

@@ -47,6 +47,17 @@ module Protocol
 				end
 			end
 			
+			# Accept an incoming push promise from the other side of the connection.
+			# On the client side, we accept push promise streams.
+			# On the server side, streams create push promise streams.
+			def accept_push_promise_stream(stream_id, &block)
+				accept_stream(stream_id, &block)
+			end
+			
+			def create_push_promise_stream
+				raise ProtocolError, "Cannot create push promises from client!"
+			end
+			
 			def receive_push_promise(frame)
 				if frame.stream_id == 0
 					raise ProtocolError, "Cannot receive headers for stream 0!"

data/lib/protocol/http2/connection.rb

@@ -274,8 +274,9 @@ module Protocol
 				false
 			end
 			
-			# Accept a stream from the other side of the connnection.
-			def accept_stream(stream_id)
+			# Accept an incoming stream from the other side of the connnection.
+			# On the server side, we accept requests.
+			def accept_stream(stream_id, &block)
 				unless valid_remote_stream_id?(stream_id)
 					raise ProtocolError, "Invalid remote stream id: #{stream_id}"
 				end
@@ -285,14 +286,36 @@ module Protocol
 				end
 				
 				@remote_stream_id = stream_id
-				create_stream(stream_id)
+				
+				create_stream(stream_id, &block)
+			end
+			
+			def accept_push_promise_stream(stream_id, &block)
+				accept_stream(stream_id, &block)
+			end
+			
+			# Create a stream, defaults to an outgoing stream.
+			# On the client side, we create requests.
+			# @return [Stream] the created stream.
+			def create_stream(stream_id = next_stream_id, &block)
+				if block_given?
+					yield(stream_id)
+				else
+					return Stream.new(self, stream_id)
+				end
+				
+				if stream = @streams[stream_id]
+					return stream
+				else
+					raise ProtocolError, "Stream creation failed!"
+				end
 			end
 			
-			# Create a stream on this side of the connection.
-			def create_stream(stream_id = next_stream_id)
-				@streams[stream_id] = Stream.new(self, stream_id)
+			def create_push_promise_stream(&block)
+				create_stream(&block)
 			end
 			
+			# On the server side, starts a new request.
 			def receive_headers(frame)
 				if frame.stream_id == 0
 					raise ProtocolError, "Cannot receive headers for stream 0!"
@@ -310,6 +333,7 @@ module Protocol
 				end
 			end
 			
+			# On the client and server side, sets the priority for an incoming stream.
 			def receive_priority(frame)
 				if stream = @streams[frame.stream_id]
 					stream.receive_priority(frame)
@@ -319,6 +343,10 @@ module Protocol
 				end
 			end
 			
+			def receive_push_promise(frame)
+				raise ProtocolError, "Unable to receive push promise!"
+			end
+			
 			def receive_reset_stream(frame)
 				if stream = @streams[frame.stream_id]
 					stream.receive_reset_stream(frame)

data/lib/protocol/http2/server.rb

@@ -45,12 +45,12 @@ module Protocol
 				end
 			end
 			
-			def enable_push?
-				@remote_settings.enable_push?
+			def accept_push_promise_stream(stream_id, &block)
+				raise ProtocolError, "Cannot accept push promises on server!"
 			end
 			
-			def receive_push_promise
-				raise ProtocolError, "Server cannot receive push promises."
+			def enable_push?
+				@remote_settings.enable_push?
 			end
 		end
 	end

data/lib/protocol/http2/stream.rb

@@ -70,6 +70,7 @@ module Protocol
 		#    ES: END_STREAM flag
 		#    R:  RST_STREAM frame
 		#
+		# State transition methods use a trailing "!".
 		class Stream
 			include FlowControl
 			
@@ -85,6 +86,8 @@ module Protocol
 				
 				@headers = nil
 				@data = nil
+				
+				@connection.streams[@id] = self
 			end
 			
 			# Stream ID (odd for client initiated streams, even otherwise).
@@ -116,7 +119,7 @@ module Protocol
 			end
 			
 			def closed?
-				@state == :closed or @state == :reset
+				@state == :closed
 			end
 			
 			def send_headers?
@@ -171,7 +174,7 @@ module Protocol
 					frame = write_headers(*args)
 					
 					if frame.end_stream?
-						close
+						close!
 					end
 				else
 					raise ProtocolError, "Cannot send headers in state: #{@state}"
@@ -207,15 +210,16 @@ module Protocol
 					frame = write_data(*args)
 					
 					if frame.end_stream?
-						close
+						close!
 					end
 				else
 					raise ProtocolError, "Cannot send data in state: #{@state}"
 				end
 			end
 			
-			def close(state = :closed)
-				@state = state
+			# This is not the same as a `close` method. If you are looking for that, use `send_stream_reset`.
+			def close!
+				@state = :closed
 			end
 			
 			def send_reset_stream(error_code = 0)
@@ -225,7 +229,7 @@ module Protocol
 					
 					write_frame(frame)
 					
-					close(:reset)
+					close!
 				else
 					raise ProtocolError, "Cannot reset stream in state: #{@state}"
 				end
@@ -263,12 +267,10 @@ module Protocol
 					@headers = process_headers(frame)
 				elsif @state == :half_closed_local
 					if frame.end_stream?
-						close
+						close!
 					end
 					
 					@headers = process_headers(frame)
-				elsif @state == :reset
-					# ignore...
 				else
 					raise ProtocolError, "Cannot receive headers in state: #{@state}"
 				end
@@ -288,12 +290,10 @@ module Protocol
 					consume_local_window(frame)
 					
 					if frame.end_stream?
-						close
+						close!
 					end
 					
 					@data = frame.unpack
-				elsif @state == :reset
-					# ignore...
 				else
 					raise ProtocolError, "Cannot receive data in state: #{@state}"
 				end
@@ -305,7 +305,7 @@ module Protocol
 			
 			def receive_reset_stream(frame)
 				if @state != :idle and @state != :closed
-					close
+					close!
 					
 					return frame.unpack
 				else
@@ -343,15 +343,16 @@ module Protocol
 				end
 			end
 			
-			def create_promise_stream(headers, stream_id)
-				@connection.create_stream(stream_id)
+			# Override this function to implement your own push promise logic.
+			def create_push_promise_stream(headers)
+				@connection.create_push_promise_stream
 			end
 			
 			# Server push is semantically equivalent to a server responding to a request; however, in this case, that request is also sent by the server, as a PUSH_PROMISE frame.
 			# @param headers [Hash] contains a complete set of request header fields that the server attributes to the request.
-			def send_push_promise(headers, stream_id = @connection.next_stream_id)
+			def send_push_promise(headers)
 				if @state == :open or @state == :half_closed_remote
-					promised_stream = self.create_promise_stream(headers, stream_id)
+					promised_stream = self.create_push_promise_stream(headers)
 					promised_stream.reserved_local!
 					
 					write_push_promise(promised_stream.id, headers)
@@ -362,11 +363,16 @@ module Protocol
 				end
 			end
 			
+			# Override this function to implement your own push promise logic.
+			def accept_push_promise_stream(stream_id, headers)
+				@connection.accept_push_promise_stream(stream_id)
+			end
+			
 			def receive_push_promise(frame)
 				promised_stream_id, data = frame.unpack
 				headers = @connection.decode_headers(data)
 				
-				stream = self.create_promise_stream(headers, promised_stream_id)
+				stream = self.accept_push_promise_stream(promised_stream_id, headers)
 				stream.reserved_remote!
 				
 				return stream, headers

data/lib/protocol/http2/version.rb

@@ -20,6 +20,6 @@
 
 module Protocol
 	module HTTP2
-		VERSION = "0.4.1"
+		VERSION = "0.5.0"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http2
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams