Class: Protocol::HTTP2::Stream

Inherits:
Object
  • Object
show all
Includes:
FlowControlled
Defined in:
lib/protocol/http2/stream.rb

Overview

A single HTTP/2 connection can multiplex multiple streams in parallel: multiple requests and responses can be in flight simultaneously and stream data can be interleaved and prioritized.

This class encapsulates all of the state, transition, flow-control, and error management as defined by the HTTP 2.0 specification. All you have to do is subscribe to appropriate events (marked with “:” prefix in diagram below) and provide your application logic to handle request and response processing.

“‘

                  ┌────────┐
          send PP │        │ recv PP
       ┌──────────┤  idle  ├──────────┐
       │          │        │          │
       ▼          └───┬────┘          ▼
┌──────────┐          │           ┌──────────┐
│          │          │ send H /  │          │

┌──────┼ reserved │ │ recv H │ reserved ├──────┐│ │ (local) │ │ │ (remote) │ ││ └───┬──────┘ ▼ └──────┬───┘ ││ │ ┌────────┐ │ ││ │ recv ES │ │ send ES │ ││ send H │ ┌─────────┤ open ├─────────┐ │ recv H ││ │ │ │ │ │ │ ││ ▼ ▼ └───┬────┘ ▼ ▼ ││ ┌──────────┐ │ ┌──────────┐ ││ │ half │ │ │ half │ ││ │ closed │ │ send R / │ closed │ ││ │ (remote) │ │ recv R │ (local) │ ││ └────┬─────┘ │ └─────┬────┘ ││ │ │ │ ││ │ send ES / │ recv ES / │ ││ │ send R / ▼ send R / │ ││ │ recv R ┌────────┐ recv R │ ││ send R / └───────────►│ │◄───────────┘ send R / ││ recv R │ closed │ recv R │└───────────────────────►│ │◄───────────────────────┘

└────────┘

“‘

  • ‘send`: endpoint sends this frame

  • ‘recv`: endpoint receives this frame

  • H: HEADERS frame (with implied CONTINUATIONs)

  • PP: PUSH_PROMISE frame (with implied CONTINUATIONs)

  • ES: END_STREAM flag

  • R: RST_STREAM frame

State transition methods use a trailing “!”.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from FlowControlled

#available_frame_size, #available_size, #consume_local_window, #receive_window_update, #request_window_update, #send_window_update, #update_local_window, #window_updated

Constructor Details

#initialize(connection, id, state = :idle) ⇒ Stream

Returns a new instance of Stream.



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/protocol/http2/stream.rb', line 71

def initialize(connection, id, state = :idle)
	@connection = connection
	@id = id
	
	@state = state
	
	@local_window = Window.new(@connection.local_settings.initial_window_size)
	@remote_window = Window.new(@connection.remote_settings.initial_window_size)
	
	@priority = nil
end

Instance Attribute Details

#connection ⇒ Object (readonly)

The connection this stream belongs to.



84
85
86
 
# File 'lib/protocol/http2/stream.rb', line 84

def connection
  @connection
end

#id ⇒ Object (readonly)

Stream ID (odd for client initiated streams, even otherwise).



87
88
89
 
# File 'lib/protocol/http2/stream.rb', line 87

def id
  @id
end

#local_window ⇒ Object (readonly)

Returns the value of attribute local_window.



92
93
94
 
# File 'lib/protocol/http2/stream.rb', line 92

def local_window
  @local_window
end

#priority ⇒ Object

Returns the value of attribute priority.



96
97
98
 
# File 'lib/protocol/http2/stream.rb', line 96

def priority
  @priority
end

#remote_window ⇒ Object (readonly)

Returns the value of attribute remote_window.



93
94
95
 
# File 'lib/protocol/http2/stream.rb', line 93

def remote_window
  @remote_window
end

#state ⇒ Object

Stream state, e.g. ‘idle`, `closed`.



90
91
92
 
# File 'lib/protocol/http2/stream.rb', line 90

def state
  @state
end

#the priority of the stream.(priorityofthestream.) ⇒ Object (readonly) 



96
 
# File 'lib/protocol/http2/stream.rb', line 96

attr_accessor :priority

Class Method Details

.create(connection, id) ⇒ Object 



63
64
65
66
67
68
69
 
# File 'lib/protocol/http2/stream.rb', line 63

def self.create(connection, id)
	stream = self.new(connection, id)
	
	connection.streams[id] = stream
	
	return stream
end

Instance Method Details

#accept_push_promise_stream(stream_id, headers) ⇒ Object

Override this function to implement your own push promise logic.



401
402
403
 
# File 'lib/protocol/http2/stream.rb', line 401

def accept_push_promise_stream(stream_id, headers)
	@connection.accept_push_promise_stream(stream_id)
end

#active? ⇒ Boolean

Returns:

  • (Boolean) 


106
107
108
 
# File 'lib/protocol/http2/stream.rb', line 106

def active?
	@state != :closed && @state != :idle
end

#close(error = nil) ⇒ Object

Transition directly to closed state. Do not pass go, do not collect $200. This method should only be used by ‘Connection#close`.



116
117
118
119
120
121
 
# File 'lib/protocol/http2/stream.rb', line 116

def close(error = nil)
	unless closed?
		@state = :closed
		self.closed(error)
	end
end

#close!(error_code = nil) ⇒ Object

Transition the stream into the closed state.



224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/protocol/http2/stream.rb', line 224

def close!(error_code = nil)
	@state = :closed
	@connection.delete(@id)
	
	if error_code
		error = StreamError.new("Stream closed!", error_code)
	end
	
	self.closed(error)
	
	return self
end

#closed(error = nil) ⇒ Object

The stream has been closed. If closed due to a stream reset, the error will be set.



219
220
 
# File 'lib/protocol/http2/stream.rb', line 219

def closed(error = nil)
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/protocol/http2/stream.rb', line 110

def closed?
	@state == :closed
end

#consume_remote_window(frame) ⇒ Object 



173
174
175
176
177
 
# File 'lib/protocol/http2/stream.rb', line 173

def consume_remote_window(frame)
	super
	
	@connection.consume_remote_window(frame)
end

#create_push_promise_stream(headers) ⇒ Object

Override this function to implement your own push promise logic.



379
380
381
 
# File 'lib/protocol/http2/stream.rb', line 379

def create_push_promise_stream(headers)
	@connection.create_push_promise_stream
end

#ignore_data(frame) ⇒ Object 



298
299
300
 
# File 'lib/protocol/http2/stream.rb', line 298

def ignore_data(frame)
	# Console.warn(self) {"Received headers in state: #{@state}!"}
end

#inspect ⇒ Object 



415
416
417
 
# File 'lib/protocol/http2/stream.rb', line 415

def inspect
	"\#<#{self.class} id=#{@id} state=#{@state}>"
end

#maximum_frame_size ⇒ Object 



98
99
100
 
# File 'lib/protocol/http2/stream.rb', line 98

def maximum_frame_size
	@connection.available_frame_size
end

#open! ⇒ Object 



208
209
210
211
212
213
214
215
216
 
# File 'lib/protocol/http2/stream.rb', line 208

def open!
	if @state == :idle
		@state = :open
	else
		raise ProtocolError, "Cannot open stream in state: #{@state}"
	end
	
	return self
end

#process_data(frame) ⇒ String

Returns the data that was received.

Returns:

  • (String) —

    the data that was received.



294
295
296
 
# File 'lib/protocol/http2/stream.rb', line 294

def process_data(frame)
	frame.unpack
end

#process_headers(frame) ⇒ Object 



250
251
252
253
254
255
 
# File 'lib/protocol/http2/stream.rb', line 250

def process_headers(frame)
	# Receiving request headers:
	data = frame.unpack
	
	@connection.decode_headers(data)
end

#receive_data(frame) ⇒ Object

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.



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/protocol/http2/stream.rb', line 303

def receive_data(frame)
	if @state == :open
		update_local_window(frame)
		
		if frame.end_stream?
			@state = :half_closed_remote
		end
		
		process_data(frame)
	elsif @state == :half_closed_local
		update_local_window(frame)
		
		process_data(frame)
		
		if frame.end_stream?
			close!
		end
	elsif self.closed?
		ignore_data(frame)
	else
		# 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 (Section 5.4.2) of type STREAM_CLOSED.
		self.send_reset_stream(Error::STREAM_CLOSED)
	end
end

#receive_headers(frame) ⇒ Object 



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/protocol/http2/stream.rb', line 261

def receive_headers(frame)
	if @state == :idle
		if frame.end_stream?
			@state = :half_closed_remote
		else
			open!
		end
		
		process_headers(frame)
	elsif @state == :reserved_remote
		process_headers(frame)
		
		@state = :half_closed_local
	elsif @state == :open
		process_headers(frame)
		
		if frame.end_stream?
			@state = :half_closed_remote
		end
	elsif @state == :half_closed_local
		process_headers(frame)
		
		if frame.end_stream?
			close!
		end
	elsif self.closed?
		ignore_headers(frame)
	else
		self.send_reset_stream(Error::STREAM_CLOSED)
	end
end

#receive_push_promise(frame) ⇒ Object 



405
406
407
408
409
410
411
412
413
 
# File 'lib/protocol/http2/stream.rb', line 405

def receive_push_promise(frame)
	promised_stream_id, data = frame.unpack
	headers = @connection.decode_headers(data)
	
	stream = self.accept_push_promise_stream(promised_stream_id, headers)
	stream.reserved_remote!
	
	return stream, headers
end

#receive_reset_stream(frame) ⇒ Object 



328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/protocol/http2/stream.rb', line 328

def receive_reset_stream(frame)
	if @state == :idle
		# If a RST_STREAM frame identifying an idle stream is received, the recipient MUST treat this as a connection error (Section 5.4.1) of type PROTOCOL_ERROR.
		raise ProtocolError, "Cannot receive reset stream in state: #{@state}!"
	else
		error_code = frame.unpack
		
		close!(error_code)
		
		return error_code
	end
end

#reserved_local! ⇒ Object 



358
359
360
361
362
363
364
365
366
 
# File 'lib/protocol/http2/stream.rb', line 358

def reserved_local!
	if @state == :idle
		@state = :reserved_local
	else
		raise ProtocolError, "Cannot reserve stream in state: #{@state}"
	end
	
	return self
end

#reserved_remote! ⇒ Object 



368
369
370
371
372
373
374
375
376
 
# File 'lib/protocol/http2/stream.rb', line 368

def reserved_remote!
	if @state == :idle
		@state = :reserved_remote
	else
		raise ProtocolError, "Cannot reserve stream in state: #{@state}"
	end
	
	return self
end

#send_data(*arguments, **options) ⇒ Object 



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/protocol/http2/stream.rb', line 190

def send_data(*arguments, **options)
	if @state == :open
		frame = write_data(*arguments, **options)
		
		if frame.end_stream?
			@state = :half_closed_local
		end
	elsif @state == :half_closed_remote
		frame = write_data(*arguments, **options)
		
		if frame.end_stream?
			close!
		end
	else
		raise ProtocolError, "Cannot send data in state: #{@state}"
	end
end

#send_headers(*arguments) ⇒ Object

The HEADERS frame is used to open a stream, and additionally carries a header block fragment. HEADERS frames can be sent on a stream in the “idle”, “reserved (local)”, “open”, or “half-closed (remote)” state.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/protocol/http2/stream.rb', line 143

def send_headers(*arguments)
	if @state == :idle
		frame = write_headers(*arguments)
		
		if frame.end_stream?
			@state = :half_closed_local
		else
			open!
		end
	elsif @state == :reserved_local
		frame = write_headers(*arguments)
		
		@state = :half_closed_remote
	elsif @state == :open
		frame = write_headers(*arguments)
		
		if frame.end_stream?
			@state = :half_closed_local
		end
	elsif @state == :half_closed_remote
		frame = write_headers(*arguments)
		
		if frame.end_stream?
			close!
		end
	else
		raise ProtocolError, "Cannot send headers in state: #{@state}"
	end
end

#send_headers? ⇒ Boolean

HEADERS frames can be sent on a stream in the “idle”, “reserved (local)”, “open”, or “half-closed (remote)” state. Despite it’s name, it can also be used for trailers.

Returns:

  • (Boolean) 


124
125
126
 
# File 'lib/protocol/http2/stream.rb', line 124

def send_headers?
	@state == :idle or @state == :reserved_local or @state == :open or @state == :half_closed_remote
end

#send_push_promise(headers) ⇒ Object

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.



385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/protocol/http2/stream.rb', line 385

def send_push_promise(headers)
	if @state == :open or @state == :half_closed_remote
		promised_stream = self.create_push_promise_stream(headers)
		promised_stream.reserved_local!
		
		# The headers are the same as if the client had sent a request:
		write_push_promise(promised_stream.id, headers)
		
		# The server should call send_headers on the promised stream to begin sending the response:
		return promised_stream
	else
		raise ProtocolError, "Cannot send push promise in state: #{@state}"
	end
end

#send_reset_stream(error_code = 0) ⇒ Object 



237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/protocol/http2/stream.rb', line 237

def send_reset_stream(error_code = 0)
	if @state != :idle and @state != :closed
		frame = ResetStreamFrame.new(@id)
		frame.pack(error_code)
		
		write_frame(frame)
		
		close!
	else
		raise ProtocolError, "Cannot send reset stream (#{error_code}) in state: #{@state}"
	end
end

#write_frame(frame) ⇒ Object 



102
103
104
 
# File 'lib/protocol/http2/stream.rb', line 102

def write_frame(frame)
	@connection.write_frame(frame)
end