Class: Protocol::HTTP2::Connection

Inherits:
Object
  • Object
show all
Includes:
FlowControl
Defined in:
lib/protocol/http2/connection.rb

Direct Known Subclasses

Client, Server

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from FlowControl

#available_frame_size, #available_size, #consume_local_window, #consume_remote_window, #consume_window, #request_window_update, #send_window_update, #update_local_window, #window_updated

Constructor Details

#initialize(framer, local_stream_id) ⇒ Connection

Returns a new instance of Connection.



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
 
# File 'lib/protocol/http2/connection.rb', line 31

def initialize(framer, local_stream_id)
  super()
  
  @state = :new
  
  # Hash(Integer, Stream)
  @streams = {}
  
  # Hash(Integer, Dependency)
  @dependency = Dependency.new(self, 0)
  @dependencies = {0 => @dependency}
  
  @framer = framer
  @local_stream_id = local_stream_id
  @remote_stream_id = 0
  
  @local_settings = PendingSettings.new
  @remote_settings = Settings.new
  
  @decoder = HPACK::Context.new
  @encoder = HPACK::Context.new
  
  @local_window = Window.new(@local_settings.initial_window_size)
  @remote_window = Window.new(@remote_settings.initial_window_size)
end

Instance Attribute Details

#dependencies ⇒ Object (readonly)

Returns the value of attribute dependencies.



143
144
145
 
# File 'lib/protocol/http2/connection.rb', line 143

def dependencies
  @dependencies
end

#framer ⇒ Object (readonly)

Returns the value of attribute framer.



86
87
88
 
# File 'lib/protocol/http2/connection.rb', line 86

def framer
  @framer
end

#local_settings ⇒ Object

Current settings value for local and peer



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

def local_settings
  @local_settings
end

#local_window ⇒ Object (readonly)

Our window for receiving data. When we receive data, it reduces this window. If the window gets too small, we must send a window update.



97
98
99
 
# File 'lib/protocol/http2/connection.rb', line 97

def local_window
  @local_window
end

#remote_settings ⇒ Object

Returns the value of attribute remote_settings.



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

def remote_settings
  @remote_settings
end

#remote_stream_id ⇒ Object (readonly)

The highest stream_id that has been successfully accepted by this connection.



103
104
105
 
# File 'lib/protocol/http2/connection.rb', line 103

def remote_stream_id
  @remote_stream_id
end

#remote_window ⇒ Object (readonly)

Our window for sending data. When we send data, it reduces this window.



100
101
102
 
# File 'lib/protocol/http2/connection.rb', line 100

def remote_window
  @remote_window
end

#state ⇒ Object

Connection state (:new, :open, :closed).



89
90
91
 
# File 'lib/protocol/http2/connection.rb', line 89

def state
  @state
end

#streams ⇒ Object (readonly)

Returns the value of attribute streams.



142
143
144
 
# File 'lib/protocol/http2/connection.rb', line 142

def streams
  @streams
end

Instance Method Details

#[](id) ⇒ Object 



69
70
71
72
73
74
75
 
# File 'lib/protocol/http2/connection.rb', line 69

def [] id
  if id.zero?
    self
  else
    @streams[id]
  end
end

#accept_push_promise_stream(stream_id, &block) ⇒ Object

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, existing streams create push promise streams.



361
362
363
 
# File 'lib/protocol/http2/connection.rb', line 361

def accept_push_promise_stream(stream_id, &block)
  accept_stream(stream_id, &block)
end

#accept_stream(stream_id, &block) ⇒ Object

Accept an incoming stream from the other side of the connnection. On the server side, we accept requests.



350
351
352
353
354
355
356
 
# File 'lib/protocol/http2/connection.rb', line 350

def accept_stream(stream_id, &block)
  unless valid_remote_stream_id?(stream_id)
    raise ProtocolError, "Invalid stream id: #{stream_id}"
  end
  
  create_stream(stream_id, &block)
end

#children ⇒ Object 



65
66
67
 
# File 'lib/protocol/http2/connection.rb', line 65

def children
  @dependency.streams
end

#close(error = nil) ⇒ Object

Close the underlying framer and all streams.



118
119
120
121
122
123
 
# File 'lib/protocol/http2/connection.rb', line 118

def close(error = nil)
  @framer.close
  # @framer = nil
  
  @streams.each_value{|stream| stream.close(error)}
end

#close! ⇒ Object

Transition the connection into the closed state.



212
213
214
215
216
 
# File 'lib/protocol/http2/connection.rb', line 212

def close!
  @state = :closed
  
  return self
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


105
106
107
 
# File 'lib/protocol/http2/connection.rb', line 105

def closed?
  @state == :closed
end

#create_push_promise_stream(&block) ⇒ Object 



376
377
378
 
# File 'lib/protocol/http2/connection.rb', line 376

def create_push_promise_stream(&block)
  create_stream(&block)
end

#create_stream(id = next_stream_id, &block) ⇒ Stream

Create a stream, defaults to an outgoing stream. On the client side, we create requests.

Returns:

  • (Stream) —

    the created stream.



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

def create_stream(id = next_stream_id, &block)
  if block_given?
    return yield(self, id)
  else
    return Stream.create(self, id)
  end
end

#decode_headers(data) ⇒ Object 



129
130
131
 
# File 'lib/protocol/http2/connection.rb', line 129

def decode_headers(data)
  HPACK::Decompressor.new(data, @decoder, table_size_limit: @local_settings.header_table_size).decode
end

#delete(id) ⇒ Object 



109
110
111
112
113
114
115
 
# File 'lib/protocol/http2/connection.rb', line 109

def delete(id)
  @streams.delete(id)
  
  if dependency = @dependencies[id]
    dependency.delete! if dependency.irrelevant?
  end
end

#dependency_for(id) ⇒ Object

Fetch (or create) the flow control windows for the specified stream id.

Parameters:

  • id (Integer) —

    the stream id.



147
148
149
150
151
152
153
154
155
156
 
# File 'lib/protocol/http2/connection.rb', line 147

def dependency_for(id)
  @dependencies.fetch(id) do
    dependency = Dependency.new(self, id)
    
    # TODO this might be irrelevant, if initially processing priority frame.
    @dependency.add_child(dependency)
    
    @dependencies[id] = dependency
  end
end

#encode_headers(headers, buffer = String.new.b) ⇒ Object 



125
126
127
 
# File 'lib/protocol/http2/connection.rb', line 125

def encode_headers(headers, buffer = String.new.b)
  HPACK::Compressor.new(buffer, @encoder, table_size_limit: @remote_settings.header_table_size).encode(headers)
end

#id ⇒ Object 



57
58
59
 
# File 'lib/protocol/http2/connection.rb', line 57

def id
  0
end

#ignore_frame?(frame) ⇒ Boolean

6.8. GOAWAY There is an inherent race condition between an endpoint starting new streams and the remote sending a GOAWAY frame. To deal with this case, the GOAWAY contains the stream identifier of the last peer-initiated stream that was or might be processed on the sending endpoint in this connection. For instance, if the server sends a GOAWAY frame, the identified stream is the highest-numbered stream initiated by the client. Once sent, the sender will ignore frames sent on streams initiated by the receiver if the stream has an identifier higher than the included last stream identifier. Receivers of a GOAWAY frame MUST NOT open additional streams on the connection, although a new connection can be established for new streams.

Returns:

  • (Boolean) 


161
162
163
164
165
166
167
168
 
# File 'lib/protocol/http2/connection.rb', line 161

def ignore_frame?(frame)
  if self.closed?
    # puts "ignore_frame? #{frame.stream_id} -> #{valid_remote_stream_id?(frame.stream_id)} > #{@remote_stream_id}"
    if valid_remote_stream_id?(frame.stream_id)
      return frame.stream_id > @remote_stream_id
    end
  end
end

#maximum_concurrent_streams ⇒ Object 



82
83
84
 
# File 'lib/protocol/http2/connection.rb', line 82

def maximum_concurrent_streams
  [@local_settings.maximum_concurrent_streams, @remote_settings.maximum_concurrent_streams].min
end

#maximum_frame_size ⇒ Object

The size of a frame payload is limited by the maximum size that a receiver advertises in the SETTINGS_MAX_FRAME_SIZE setting.



78
79
80
 
# File 'lib/protocol/http2/connection.rb', line 78

def maximum_frame_size
  @remote_settings.maximum_frame_size
end

#next_stream_id ⇒ Object

Streams are identified with an unsigned 31-bit integer. Streams initiated by a client MUST use odd-numbered stream identifiers; those initiated by the server MUST use even-numbered stream identifiers. A stream identifier of zero (0x0) is used for connection control messages; the stream identifier of zero cannot be used to establish a new stream.



134
135
136
137
138
139
140
 
# File 'lib/protocol/http2/connection.rb', line 134

def next_stream_id
  id = @local_stream_id
  
  @local_stream_id += 2
  
  return id
end

#open! ⇒ Object 



290
291
292
293
294
 
# File 'lib/protocol/http2/connection.rb', line 290

def open!
  @state = :open
  
  return self
end

#parent ⇒ Object 



61
62
63
 
# File 'lib/protocol/http2/connection.rb', line 61

def parent
  nil
end

#process_settings(frame) ⇒ Boolean

In addition to changing the flow-control window for streams that are not yet active, a SETTINGS frame can alter the initial flow-control window size for streams with active flow-control windows (that is, streams in the “open” or “half-closed (remote)” state). 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.

Returns:

  • (Boolean) —

    whether the frame was an acknowledgement



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/protocol/http2/connection.rb', line 267

def process_settings(frame)
  if frame.acknowledgement?
    # The remote end has confirmed the settings have been received:
    changes = @local_settings.acknowledge
    
    update_local_settings(changes)
    
    return true
  else
    # The remote end is updating the settings, we reply with acknowledgement:
    reply = frame.acknowledge
    
    write_frame(reply)
    
    changes = frame.unpack
    @remote_settings.update(changes)
    
    update_remote_settings(changes)
    
    return false
  end
end

#read_frame ⇒ Object

Reads one frame from the network and processes. Processing the frame updates the state of the connection and related streams. If the frame triggers an error, e.g. a protocol error, the connection will typically emit a goaway frame and re-raise the exception. You should continue processing frames until the underlying connection is closed.



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/protocol/http2/connection.rb', line 171

def read_frame
  frame = @framer.read_frame(@local_settings.maximum_frame_size)
  # puts "#{self.class} #{@state} read_frame: class=#{frame.class} stream_id=#{frame.stream_id} flags=#{frame.flags} length=#{frame.length} (remote_stream_id=#{@remote_stream_id})"
  # puts "Windows: local_window=#{@local_window.inspect}; remote_window=#{@remote_window.inspect}"
  
  return if ignore_frame?(frame)
  
  yield frame if block_given?
  frame.apply(self)
  
  return frame
rescue GoawayError => error
  # Go directly to jail. Do not pass go, do not collect $200.
  raise
rescue ProtocolError => error
  send_goaway(error.code || PROTOCOL_ERROR, error.message)
  
  raise
rescue HPACK::Error => error
  send_goaway(COMPRESSION_ERROR, error.message)
  
  raise
end

#receive_continuation(frame) ⇒ Object

Raises:



448
449
450
 
# File 'lib/protocol/http2/connection.rb', line 448

def receive_continuation(frame)
  raise ProtocolError, "Received unexpected continuation: #{frame.class}"
end

#receive_data(frame) ⇒ Object 



334
335
336
337
338
339
340
341
342
 
# File 'lib/protocol/http2/connection.rb', line 334

def receive_data(frame)
  update_local_window(frame)
  
  if stream = @streams[frame.stream_id]
    stream.receive_data(frame)
  else
    raise ProtocolError, "Cannot receive data for stream id #{frame.stream_id}"
  end
end

#receive_frame(frame) ⇒ Object 



452
453
454
 
# File 'lib/protocol/http2/connection.rb', line 452

def receive_frame(frame)
  # ignore.
end

#receive_goaway(frame) ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/protocol/http2/connection.rb', line 228

def receive_goaway(frame)
  # We capture the last stream that was processed.
  @remote_stream_id, error_code, message = frame.unpack
  
  self.close!
  
  if error_code != 0
    # Shut down immediately.
    raise GoawayError.new(message, error_code)
  end
end

#receive_headers(frame) ⇒ Object

On the server side, starts a new request.



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/protocol/http2/connection.rb', line 381

def receive_headers(frame)
  stream_id = frame.stream_id
  
  if stream_id.zero?
    raise ProtocolError, "Cannot receive headers for stream 0!"
  end
  
  if stream = @streams[stream_id]
    stream.receive_headers(frame)
  else
    if stream_id <= @remote_stream_id
      raise ProtocolError, "Invalid stream id: #{stream_id} <= #{@remote_stream_id}!"
    end
    
    if @streams.size < self.maximum_concurrent_streams
      stream = accept_stream(stream_id)
      @remote_stream_id = stream_id
      
      stream.receive_headers(frame)
    else
      raise ProtocolError, "Exceeded maximum concurrent streams"
    end
  end
end

#receive_ping(frame) ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/protocol/http2/connection.rb', line 318

def receive_ping(frame)
  if @state != :closed
    if frame.stream_id != 0
      raise ProtocolError, "Ping received for non-zero stream!"
    end
    
    unless frame.acknowledgement?
      reply = frame.acknowledge
      
      write_frame(reply)
    end
  else
    raise ProtocolError, "Cannot receive ping in state #{@state}"
  end
end

#receive_priority(frame) ⇒ Object

Sets the priority for an incoming stream.



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

def receive_priority(frame)
  dependency = dependency_for(frame.stream_id)
  dependency.receive_priority(frame)
end

#receive_push_promise(frame) ⇒ Object

Raises:



419
420
421
 
# File 'lib/protocol/http2/connection.rb', line 419

def receive_push_promise(frame)
  raise ProtocolError, "Unable to receive push promise!"
end

#receive_reset_stream(frame) ⇒ Object 



423
424
425
426
427
428
429
 
# File 'lib/protocol/http2/connection.rb', line 423

def receive_reset_stream(frame)
  if stream = @streams[frame.stream_id]
    stream.receive_reset_stream(frame)
  else
    raise StreamClosed, "Cannot reset stream #{frame.stream_id}"
  end
end

#receive_settings(frame) ⇒ Object 



296
297
298
299
300
301
302
303
304
305
 
# File 'lib/protocol/http2/connection.rb', line 296

def receive_settings(frame)
  if @state == :new
    # We transition to :open when we receive acknowledgement of first settings frame:
    open! if process_settings(frame)
  elsif @state != :closed
    process_settings(frame)
  else
    raise ProtocolError, "Cannot receive settings in state #{@state}"
  end
end

#receive_window_update(frame) ⇒ Object 



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/protocol/http2/connection.rb', line 431

def receive_window_update(frame)
  if frame.connection?
    super
    
    self.consume_window
  elsif stream = @streams[frame.stream_id]
    begin
      stream.receive_window_update(frame)
    rescue ProtocolError => error
      stream.send_reset_stream(error.code)
    end
  elsif frame.stream_id > @remote_stream_id
    # Receiving any frame other than HEADERS or PRIORITY on a stream in this state MUST be treated as a connection error of type PROTOCOL_ERROR.
    raise ProtocolError, "Cannot update window of idle stream #{frame.stream_id}"
  end
end

#send_goaway(error_code = 0, message = "") ⇒ Object

Tell the remote end that the connection is being shut down. If the ‘error_code` is 0, this is a graceful shutdown. The other end of the connection should not make any new streams, but existing streams may be completed.



219
220
221
222
223
224
225
226
 
# File 'lib/protocol/http2/connection.rb', line 219

def send_goaway(error_code = 0, message = "")
  frame = GoawayFrame.new
  frame.pack @remote_stream_id, error_code, message
  
  write_frame(frame)
ensure
  self.close!
end

#send_ping(data) ⇒ Object 



307
308
309
310
311
312
313
314
315
316
 
# File 'lib/protocol/http2/connection.rb', line 307

def send_ping(data)
  if @state != :closed
    frame = PingFrame.new
    frame.pack data
    
    write_frame(frame)
  else
    raise ProtocolError, "Cannot send ping in state #{@state}"
  end
end

#send_priority(stream_id, priority) ⇒ Object 



406
407
408
409
410
411
 
# File 'lib/protocol/http2/connection.rb', line 406

def send_priority(stream_id, priority)
  frame = PriorityFrame.new(stream_id)
  frame.pack(priority)
  
  write_frame(frame)
end

#send_settings(changes) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/protocol/http2/connection.rb', line 195

def send_settings(changes)
  @local_settings.append(changes)
  
  frame = SettingsFrame.new
  frame.pack(changes)
  
  write_frame(frame)
  
  # If the initial window size is set to something bigger than the default, we want to increase it.
  difference = @local_settings.pending.initial_window_size - @local_window.capacity
  
  if difference > 0
    send_window_update(difference)
  end
end

#update_local_settings(changes) ⇒ Object 



248
249
250
251
252
253
254
 
# File 'lib/protocol/http2/connection.rb', line 248

def update_local_settings(changes)
  capacity = @local_settings.initial_window_size
  
  @streams.each_value do |stream|
    stream.local_window.capacity = capacity
  end
end

#update_remote_settings(changes) ⇒ Object 



256
257
258
259
260
261
262
 
# File 'lib/protocol/http2/connection.rb', line 256

def update_remote_settings(changes)
  capacity = @remote_settings.initial_window_size
  
  @streams.each_value do |stream|
    stream.remote_window.capacity = capacity
  end
end

#valid_remote_stream_id? ⇒ Boolean

Returns:

  • (Boolean) 


344
345
346
 
# File 'lib/protocol/http2/connection.rb', line 344

def valid_remote_stream_id?
  false
end

#write_frame(frame) ⇒ Object 



240
241
242
 
# File 'lib/protocol/http2/connection.rb', line 240

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

#write_frames {|@framer| ... } ⇒ Object

Yields:



244
245
246
 
# File 'lib/protocol/http2/connection.rb', line 244

def write_frames
  yield @framer
end