-
-
Notifications
You must be signed in to change notification settings - Fork 9
/
stream.rb
457 lines (367 loc) · 13.6 KB
/
stream.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
require_relative 'connection'
require_relative 'dependency'
module Protocol
module HTTP2
# A single HTTP 2.0 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 |--------.
# / | | \
# v +--------+ v
# +----------+ | +----------+
# | | | send H / | |
# ,------| reserved | | recv H | reserved |------.
# | | (local) | | | (remote) | |
# | +----------+ v +----------+ |
# | | +--------+ | |
# | | recv ES | | send ES | |
# | send H | ,-------| open |-------. | recv H |
# | | / | | \ | |
# | v v +--------+ v v |
# | +----------+ | +----------+ |
# | | half | | | half | |
# | | closed | | send R / | closed | |
# | | (remote) | | recv R | (local) | |
# | +----------+ | +----------+ |
# | | | | |
# | | send ES / | recv ES / | |
# | | send R / v 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 "!".
class Stream
include FlowControlled
def self.create(connection, id)
stream = self.new(connection, id)
connection.streams[id] = stream
return stream
end
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)
@dependency = Dependency.create(@connection, @id)
end
# The connection this stream belongs to.
attr :connection
# Stream ID (odd for client initiated streams, even otherwise).
attr :id
# Stream state, e.g. `idle`, `closed`.
attr_accessor :state
attr :dependency
attr :local_window
attr :remote_window
def weight
@dependency.weight
end
def priority
@dependency.priority
end
def priority= priority
@dependency.priority = priority
end
def parent=(stream)
@dependency.parent = stream.dependency
end
def maximum_frame_size
@connection.available_frame_size
end
def write_frame(frame)
@connection.write_frame(frame)
end
def active?
@state != :closed && @state != :idle
end
def closed?
@state == :closed
end
# Transition directly to closed state. Do not pass go, do not collect $200.
# This method should only be used by `Connection#close`.
def close(error = nil)
unless closed?
@state = :closed
self.closed(error)
end
end
def send_headers?
@state == :idle or @state == :reserved_local or @state == :open or @state == :half_closed_remote
end
private def write_headers(priority, headers, flags = 0)
frame = HeadersFrame.new(@id, flags)
@connection.write_frames do |framer|
data = @connection.encode_headers(headers)
frame.pack(priority, data, maximum_size: @connection.maximum_frame_size)
framer.write_frame(frame)
end
return frame
end
# 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.
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
def consume_remote_window(frame)
super
@connection.consume_remote_window(frame)
end
private def write_data(data, flags = 0, **options)
frame = DataFrame.new(@id, flags)
frame.pack(data, **options)
# This might fail if the data payload was too big:
consume_remote_window(frame)
write_frame(frame)
return frame
end
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
# The stream has been opened.
def opened(error = nil)
end
def open!
if @state == :idle
@state = :open
else
raise ProtocolError, "Cannot open stream in state: #{@state}"
end
self.opened
return self
end
# The stream has been closed. If closed due to a stream reset, the error will be set.
def closed(error = nil)
end
# Transition the stream into the closed state.
# @param error_code [Integer] the error code if the stream was closed due to a stream reset.
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
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
def process_headers(frame)
# Receiving request headers:
priority, data = frame.unpack
if priority
@dependency.process_priority(priority)
end
@connection.decode_headers(data)
end
protected def ignore_headers(frame)
# Async.logger.warn(self) {"Received headers in state: #{@state}!"}
end
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
# @return [String] the data that was received.
def process_data(frame)
frame.unpack
end
def ignore_data(frame)
# Async.logger.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.
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
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
# A normal request is client request -> server response -> client.
# A push promise is server request -> client -> server response -> client.
# The server generates the same set of headers as if the client was sending a request, and sends these to the client. The client can reject the request by resetting the (new) stream. Otherwise, the server will start sending a response as if the client had send the request.
private def write_push_promise(stream_id, headers, flags = 0, **options)
frame = PushPromiseFrame.new(@id, flags)
@connection.write_frames do |framer|
data = @connection.encode_headers(headers)
frame.pack(stream_id, data, maximum_size: @connection.maximum_frame_size)
framer.write_frame(frame)
end
return frame
end
def reserved_local!
if @state == :idle
@state = :reserved_local
else
raise ProtocolError, "Cannot reserve stream in state: #{@state}"
end
end
def reserved_remote!
if @state == :idle
@state = :reserved_remote
else
raise ProtocolError, "Cannot reserve stream in state: #{@state}"
end
end
# 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)
if @state == :open or @state == :half_closed_remote
promised_stream = self.create_push_promise_stream(headers)
promised_stream.reserved_local!
write_push_promise(promised_stream.id, headers)
return promised_stream
else
raise ProtocolError, "Cannot send push promise in state: #{@state}"
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.accept_push_promise_stream(promised_stream_id, headers)
stream.parent = self
stream.reserved_remote!
return stream, headers
end
def inspect
"\#<#{self.class} id=#{@id} state=#{@state}>"
end
def to_s
inspect
end
end
end
end