Class: Quic::Stream

Inherits:
Object
  • Object
show all
Defined in:
lib/quic/stream.rb

Overview

Quic::Stream is defined in the C extension (ext/quic/stream.c); this file reopens it to add the bits that are easier to express in Ruby: #initiator (a tiny lookup over @id) and the blocking #read which wraps the C #read_nonblock with an internal Client#pump_until loop.

Constant Summary collapse

INITIATORS = 
%i[client_bidi server_bidi client_uni server_uni].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#id ⇒ Object (readonly) Also known as: stream_id

Returns the value of attribute id.



11
12
13
 
# File 'lib/quic/stream.rb', line 11

def id
  @id
end

Instance Method Details

#initiator ⇒ Object

RFC 9000 §2.1: the lowest two bits of stream_id encode the initiator (LSB) and direction (bit 1).



16
17
18
 
# File 'lib/quic/stream.rb', line 16

def initiator
  INITIATORS[@id & 0b11]
end

#read(length = nil) ⇒ Object

IO#read-compatible blocking read. Requires the parent Client to have been #bind’ed to a socket (raised via Client#pump_once otherwise).

read(length): block until at least 1 byte is available or EOF,
              return up to `length` bytes, return nil at EOF.
read(nil):    block until EOF, return everything that was received
              (an empty String if nothing arrived before FIN).



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
 
# File 'lib/quic/stream.rb', line 27

def read(length = nil)
  if length.nil?
    @client.pump_until { eof? }
    out = +""
    out.force_encoding(Encoding::BINARY)
    until eof?
      # Should not happen given pump_until's predicate, but defensive.
      out << read_nonblock(4096)
    end
    # Drain anything that arrived after the predicate was last evaluated.
    loop do
      out << read_nonblock(4096)
    rescue Quic::Error::WaitReadable, EOFError
      break
    end
    out
  else
    @client.pump_until { @recv_buffer.bytesize > 0 || @fin_received }
    begin
      read_nonblock(length)
    rescue EOFError
      nil
    end
  end
end