Module: Plum::StreamUtils

Included in:
Stream
Defined in:
lib/plum/stream_utils.rb

Instance Method Summary collapse

Instance Method Details

#promise(headers) ⇒ Stream

Reserves a stream to server push. Sends PUSH_PROMISE and create new stream.

Parameters:

  • headers (Enumerable<String, String>) —

    The request headers. It must contain all of them: ‘:authority’, ‘:method’, ‘:scheme’ and ‘:path’.

Returns:

  • (Stream) —

    The stream to send push response.



20
21
22
23
24
25
26
27
28
 
# File 'lib/plum/stream_utils.rb', line 20

def promise(headers)
  stream = @connection.reserve_stream(weight: self.weight + 1, parent: self)
  encoded = @connection.hpack_encoder.encode(headers)
  original = Frame.push_promise(id, stream.id, encoded, :end_headers)
  original.split_headers(@connection.remote_settings[:max_frame_size]).each do |frame|
    send frame
  end
  stream
end

#respond(headers, body = nil, end_stream: true) ⇒ Object

Responds to a HTTP request.

Parameters:

  • headers (Enumerable<String, String>) —

    The response headers.

  • body (String, IO) (defaults to: nil) —

    The response body.



8
9
10
11
12
13
14
15
 
# File 'lib/plum/stream_utils.rb', line 8

def respond(headers, body = nil, end_stream: true) # TODO: priority, padding
  if body
    send_headers(headers, end_stream: false)
    send_data(body, end_stream: end_stream)
  else
    send_headers(headers, end_stream: end_stream)
  end
end

#send_data(data, end_stream: true) ⇒ Object

Sends DATA frame. If the data is larger than MAX_FRAME_SIZE, DATA frame will be splitted.

Parameters:

  • data (String, IO) —

    The data to send.

  • end_stream (Boolean) (defaults to: true) —

    Set END_STREAM flag or not.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/plum/stream_utils.rb', line 46

def send_data(data, end_stream: true)
  max = @connection.remote_settings[:max_frame_size]
  if data.is_a?(IO)
    while !data.eof? && fragment = data.readpartial(max)
      send Frame.data(id, fragment, (end_stream && data.eof? && :end_stream))
    end
  else
    original = Frame.data(id, data, (end_stream && :end_stream))
    original.split_data(max).each do |frame|
      send frame
    end
  end
  @state = :half_closed_local if end_stream
end

#send_headers(headers, end_stream:) ⇒ Object

Sends response headers. If the encoded frame is larger than MAX_FRAME_SIZE, the headers will be splitted into HEADERS frame and CONTINUATION frame(s).

Parameters:

  • headers (Enumerable<String, String>) —

    The response headers.

  • end_stream (Boolean) —

    Set END_STREAM flag or not.



33
34
35
36
37
38
39
40
41
 
# File 'lib/plum/stream_utils.rb', line 33

def send_headers(headers, end_stream:)
  max = @connection.remote_settings[:max_frame_size]
  encoded = @connection.hpack_encoder.encode(headers)
  original_frame = Frame.headers(id, encoded, :end_headers, (end_stream && :end_stream || nil))
  original_frame.split_headers(max).each do |frame|
    send frame
  end
  @state = :half_closed_local if end_stream
end