Class: HTTPX::Connection::HTTP1

Inherits:
Object
  • Object
show all
Includes:
HTTPX::Callbacks, Loggable
Defined in:
lib/httpx/connection/http1.rb

Constant Summary collapse

MAX_REQUESTS = 
200
CRLF = 
"\r\n"

Constants included from Loggable

Loggable::COLORS, Loggable::USE_DEBUG_LOG

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Loggable

#log, #log_exception, #log_redact

Methods included from HTTPX::Callbacks

#callbacks_for?, #emit, #on, #once

Constructor Details

#initialize(buffer, options) ⇒ HTTP1

Returns a new instance of HTTP1.



17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/httpx/connection/http1.rb', line 17

def initialize(buffer, options)
  @options = options
  @max_concurrent_requests = @options.max_concurrent_requests || MAX_REQUESTS
  @max_requests = @options.max_requests
  @parser = Parser::HTTP1.new(self)
  @buffer = buffer
  @version = [1, 1]
  @pending = []
  @requests = []
  @handshake_completed = false
end

Instance Attribute Details

#max_concurrent_requests ⇒ Object

Returns the value of attribute max_concurrent_requests.



15
16
17
 
# File 'lib/httpx/connection/http1.rb', line 15

def max_concurrent_requests
  @max_concurrent_requests
end

#pending ⇒ Object (readonly)

Returns the value of attribute pending.



13
14
15
 
# File 'lib/httpx/connection/http1.rb', line 13

def pending
  @pending
end

#requests ⇒ Object (readonly)

Returns the value of attribute requests.



13
14
15
 
# File 'lib/httpx/connection/http1.rb', line 13

def requests
  @requests
end

Instance Method Details

#<<(data) ⇒ Object 



70
71
72
 
# File 'lib/httpx/connection/http1.rb', line 70

def <<(data)
  @parser << data
end

#close ⇒ Object 



50
51
52
53
 
# File 'lib/httpx/connection/http1.rb', line 50

def close
  reset
  emit(:close, true)
end

#consume ⇒ Object 



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/httpx/connection/http1.rb', line 86

def consume
  requests_limit = [@max_requests, @requests.size].min
  concurrent_requests_limit = [@max_concurrent_requests, requests_limit].min
  @requests.each_with_index do |request, idx|
    break if idx >= concurrent_requests_limit
    next unless request.can_buffer?

    handle(request)
  end
end

#dispatch ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/httpx/connection/http1.rb', line 158

def dispatch
  request = @request

  if request.expects?
    @parser.reset!
    return handle(request)
  end

  @request = nil
  @requests.shift
  response = request.response
  emit(:response, request, response)

  if @parser.upgrade?
    response << @parser.upgrade_data
    throw(:called)
  end

  @parser.reset!
  @max_requests -= 1
  if response.is_a?(ErrorResponse)
    disable
  else
    manage_connection(request, response)
  end

  if exhausted?
    @pending.concat(@requests)
    @requests.clear

    emit(:exhausted)
  else
    send(@pending.shift) unless @pending.empty?
  end
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


59
60
61
62
63
64
65
66
67
68
 
# File 'lib/httpx/connection/http1.rb', line 59

def empty?
  # this means that for every request there's an available
  # partial response, so there are no in-flight requests waiting.
  @requests.empty? || (
    # checking all responses can be time-consuming. Alas, as in HTTP/1, responses
    # do not come out of order, we can get away with checking first and last.
    !@requests.first.response.nil? &&
    (@requests.size == 1 || !@requests.last.response.nil?)
  )
end

#exhausted? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/httpx/connection/http1.rb', line 55

def exhausted?
  !@max_requests.positive?
end

#handle_error(ex, request = nil) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/httpx/connection/http1.rb', line 194

def handle_error(ex, request = nil)
  if (ex.is_a?(EOFError) || ex.is_a?(TimeoutError)) && @request && @request.response &&
     !@request.response.headers.key?("content-length") &&
     !@request.response.headers.key?("transfer-encoding")
    # if the response does not contain a content-length header, the server closing the
    # connnection is the indicator of response consumed.
    # https://greenbytes.de/tech/webdav/rfc2616.html#rfc.section.4.4
    catch(:called) { on_complete }
    return
  end

  if @pipelining
    catch(:called) { disable }
  else
    @requests.each do |req|
      next if request && request == req

      emit(:error, req, ex)
    end
    @pending.each do |req|
      next if request && request == req

      emit(:error, req, ex)
    end
  end
end

#interests ⇒ Object 



33
34
35
36
37
38
39
40
41
 
# File 'lib/httpx/connection/http1.rb', line 33

def interests
  request = @request || @requests.first

  return unless request

  return :w if request.interests == :w || !@buffer.empty?

  :r
end

#on_complete ⇒ Object 



149
150
151
152
153
154
155
156
 
# File 'lib/httpx/connection/http1.rb', line 149

def on_complete
  request = @request

  return unless request

  log(level: 2) { "parsing complete" }
  dispatch
end

#on_data(chunk) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/httpx/connection/http1.rb', line 133

def on_data(chunk)
  request = @request

  return unless request

  log(color: :green) { "-> DATA: #{chunk.bytesize} bytes..." }
  log(level: 2, color: :green) { "-> #{log_redact(chunk.inspect)}" }
  response = request.response

  response << chunk
rescue StandardError => e
  error_response = ErrorResponse.new(request, e)
  request.response = error_response
  dispatch
end

#on_headers(h) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/httpx/connection/http1.rb', line 105

def on_headers(h)
  @request = @requests.first

  return if @request.response

  log(level: 2) { "headers received" }
  headers = @request.options.headers_class.new(h)
  response = @request.options.response_class.new(@request,
                                                 @parser.status_code,
                                                 @parser.http_version.join("."),
                                                 headers)
  log(color: :yellow) { "-> HEADLINE: #{response.status} HTTP/#{@parser.http_version.join(".")}" }
  log(color: :yellow) { response.headers.each.map { |f, v| "-> HEADER: #{f}: #{log_redact(v)}" }.join("\n") }

  @request.response = response
  on_complete if response.finished?
end

#on_start ⇒ Object

HTTP Parser callbacks

must be public methods, or else they won’t be reachable



101
102
103
 
# File 'lib/httpx/connection/http1.rb', line 101

def on_start
  log(level: 2) { "parsing begins" }
end

#on_trailers(h) ⇒ Object 



123
124
125
126
127
128
129
130
131
 
# File 'lib/httpx/connection/http1.rb', line 123

def on_trailers(h)
  return unless @request

  response = @request.response
  log(level: 2) { "trailer headers received" }

  log(color: :yellow) { h.each.map { |f, v| "-> HEADER: #{f}: #{log_redact(v.join(", "))}" }.join("\n") }
  response.merge_headers(h)
end

#ping ⇒ Object 



221
222
223
224
225
 
# File 'lib/httpx/connection/http1.rb', line 221

def ping
  reset
  emit(:reset)
  emit(:exhausted)
end

#reset ⇒ Object 



43
44
45
46
47
48
 
# File 'lib/httpx/connection/http1.rb', line 43

def reset
  @max_requests = @options.max_requests || MAX_REQUESTS
  @parser.reset!
  @handshake_completed = false
  @pending.concat(@requests) unless @requests.empty?
end

#send(request) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/httpx/connection/http1.rb', line 74

def send(request)
  unless @max_requests.positive?
    @pending << request
    return
  end

  return if @requests.include?(request)

  @requests << request
  @pipelining = true if @requests.size > 1
end

#timeout ⇒ Object 



29
30
31
 
# File 'lib/httpx/connection/http1.rb', line 29

def timeout
  @options.timeout[:operation_timeout]
end

#waiting_for_ping? ⇒ Boolean

Returns:

  • (Boolean) 


227
228
229
 
# File 'lib/httpx/connection/http1.rb', line 227

def waiting_for_ping?
  false
end