Class: Async::HTTP::Protocol::HTTP2::Stream

Inherits:
Protocol::HTTP2::Stream
  • Object
show all
Defined in:
lib/async/http/protocol/http2/stream.rb

Direct Known Subclasses

Request::Stream, Response::Stream

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeStream

Returns a new instance of Stream.


33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/async/http/protocol/http2/stream.rb', line 33

def initialize(*)
	super
	
	@headers = nil
	
	# Input buffer, reading request body, or response body (receive_data):
	@length = nil
	@input = nil
	
	# Output buffer, writing request body or response body (window_updated):
	@output = nil
end

Instance Attribute Details

#headersObject

Returns the value of attribute headers.


46
47
48
# File 'lib/async/http/protocol/http2/stream.rb', line 46

def headers
  @headers
end

#inputObject (readonly)

Returns the value of attribute input.


48
49
50
# File 'lib/async/http/protocol/http2/stream.rb', line 48

def input
  @input
end

Instance Method Details

#add_header(key, value) ⇒ Object


50
51
52
53
54
55
56
57
58
59
60
# File 'lib/async/http/protocol/http2/stream.rb', line 50

def add_header(key, value)
	if key == CONNECTION
		raise ::Protocol::HTTP2::HeaderError, "Connection header is not allowed!"
	elsif key.start_with? ':'
		raise ::Protocol::HTTP2::HeaderError, "Invalid pseudo-header #{key}!"
	elsif key =~ /[A-Z]/
		raise ::Protocol::HTTP2::HeaderError, "Invalid upper-case characters in header #{key}!"
	else
		@headers.add(key, value)
	end
end

#closed(error) ⇒ Object

When the stream transitions to the closed state, this method is called. There are roughly two ways this can happen:

  • A frame is received which causes this stream to enter the closed state. This method will be invoked from the background reader task.

  • A frame is sent which causes this stream to enter the closed state. This method will be invoked from that task.

While the input stream is relatively straight forward, the output stream can trigger the second case above


166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/async/http/protocol/http2/stream.rb', line 166

def closed(error)
	super
	
	if @input
		@input.close(error)
		@input = nil
	end
	
	if @output
		@output.stop(error)
		@output = nil
	end
	
	return self
end

#finish_output(error = nil) ⇒ Object

Called when the output terminates normally.


139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/async/http/protocol/http2/stream.rb', line 139

def finish_output(error = nil)
	trailer = @output&.trailer
	
	@output = nil
	
	if error
		send_reset_stream(::Protocol::HTTP2::Error::INTERNAL_ERROR)
	else
		# Write trailer?
		if trailer&.any?
			send_headers(nil, trailer, ::Protocol::HTTP2::END_STREAM)
		else
			send_data(nil, ::Protocol::HTTP2::END_STREAM)
		end
	end
end

#prepare_input(length) ⇒ Input

Prepare the input stream which will be used for incoming data frames.

Returns:

  • (Input)

    the input body.


95
96
97
98
99
100
101
# File 'lib/async/http/protocol/http2/stream.rb', line 95

def prepare_input(length)
	if @input.nil?
		@input = Input.new(self, length)
	else
		raise ArgumentError, "Input body already prepared!"
	end
end

#process_data(frame) ⇒ Object


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/async/http/protocol/http2/stream.rb', line 110

def process_data(frame)
	data = frame.unpack
	
	if @input
		unless data.empty?
			@input.write(data)
		end
		
		if frame.end_stream?
			@input.close
			@input = nil
		end
	end
	
	return data
rescue ::Protocol::HTTP2::ProtocolError
	raise
rescue # Anything else...
	send_reset_stream(::Protocol::HTTP2::Error::INTERNAL_ERROR)
end

#process_headers(frame) ⇒ Object


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/async/http/protocol/http2/stream.rb', line 68

def process_headers(frame)
	if @headers.nil?
		@headers = ::Protocol::HTTP::Headers.new
		self.receive_initial_headers(super, frame.end_stream?)
	elsif frame.end_stream?
		self.receive_trailing_headers(super, frame.end_stream?)
	else
		raise ::Protocol::HTTP2::HeaderError, "Unable to process headers!"
	end
	
	# TODO this might need to be in an ensure block:
	if @input and frame.end_stream?
		@input.close($!)
		@input = nil
	end
rescue ::Protocol::HTTP2::HeaderError => error
	Console.logger.error(self, error)
	
	send_reset_stream(error.code)
end

#receive_trailing_headers(headers, end_stream) ⇒ Object


62
63
64
65
66
# File 'lib/async/http/protocol/http2/stream.rb', line 62

def receive_trailing_headers(headers, end_stream)
	headers.each do |key, value|
		add_header(key, value)
	end
end

#send_body(body, trailer = nil) ⇒ Object

Set the body and begin sending it.


132
133
134
135
136
# File 'lib/async/http/protocol/http2/stream.rb', line 132

def send_body(body, trailer = nil)
	@output = Output.new(self, body, trailer)
	
	@output.start
end

#update_local_window(frame) ⇒ Object


103
104
105
106
107
108
# File 'lib/async/http/protocol/http2/stream.rb', line 103

def update_local_window(frame)
	consume_local_window(frame)
	
	# This is done on demand in `Input#read`:
	# request_window_update
end

#wait_for_inputObject


89
90
91
# File 'lib/async/http/protocol/http2/stream.rb', line 89

def wait_for_input
	return @input
end

#window_updated(size) ⇒ Object


156
157
158
159
160
# File 'lib/async/http/protocol/http2/stream.rb', line 156

def window_updated(size)
	super
	
	@output&.window_updated(size)
end