module Plum::StreamUtils

Public Instance Methods

promise(headers) click to toggle source

Reserves a stream to server push. Sends PUSH_PROMISE and create new stream. @param headers [Enumerable<String, String>] The request headers. It must contain all of them: ‘:authority’, ‘:method’, ‘:scheme’ and ‘:path’. @return [Stream] The stream to send push response.

# File lib/plum/stream_utils.rb, line 8
def promise(headers)
  stream = @connection.reserve_stream(weight: self.weight + 1, parent: self)
  encoded = @connection.hpack_encoder.encode(headers)
  frame = Frame.push_promise(id, stream.id, encoded, end_headers: true)
  send frame
  stream
end
send_data(data = "", end_stream: true) click to toggle source

Sends DATA frame. If the data is larger than MAX_FRAME_SIZE, DATA frame will be splitted. @param data [String, IO] The data to send. @param end_stream [Boolean] Set END_STREAM flag or not.

# File lib/plum/stream_utils.rb, line 30
def send_data(data = "", end_stream: true)
  max = @connection.remote_settings[:max_frame_size]
  if data.is_a?(IO)
    until data.eof?
      fragment = data.readpartial(max)
      send Frame.data(id, fragment, end_stream: end_stream && data.eof?)
    end
  else
    send Frame.data(id, data, end_stream: end_stream)
  end
  @state = :half_closed_local if end_stream
end
send_headers(headers, end_stream:) click to toggle source

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). @param headers [Enumerable<String, String>] The response headers. @param end_stream [Boolean] Set END_STREAM flag or not.

# File lib/plum/stream_utils.rb, line 19
def send_headers(headers, end_stream:)
  max = @connection.remote_settings[:max_frame_size]
  encoded = @connection.hpack_encoder.encode(headers)
  frame = Frame.headers(id, encoded, end_headers: true, end_stream: end_stream)
  send frame
  @state = :half_closed_local if end_stream
end