Class: HTTPX::Connection

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Callbacks, Loggable
Defined in:
lib/httpx/connection.rb

Overview

The Connection can be watched for IO events.

It contains the io object to read/write from, and knows what to do when it can.

It defers connecting until absolutely necessary. Connection should be triggered from the IO selector (until then, any request will be queued).

A connection boots up its parser after connection is established. All pending requests will be redirected there after connection.

A connection can be prevented from closing by the parser, that is, if there are pending requests. This will signal that the connection was prematurely closed, due to a possible number of conditions:

  • Remote peer closed the connection (“Connection: close”);

  • Remote peer doesn’t support pipelining;

A connection may also route requests for a different host for which the io was connected to, provided that the IP is the same and the port and scheme as well. This will allow to share the same socket to send HTTP/2 requests to different hosts.

Defined Under Namespace

Classes: HTTP1, HTTP2

Constant Summary

Constants included from Loggable

Loggable::COLORS, Loggable::USE_DEBUG_LOG

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Callbacks

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

Methods included from Loggable

#log, #log_exception, #log_redact, #log_redact_body, #log_redact_headers

Constructor Details

#initialize(uri, options) ⇒ Connection

Returns a new instance of Connection.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/httpx/connection.rb', line 47

def initialize(uri, options)
  @current_session = @current_selector =
    @parser = @sibling = @coalesced_connection = @altsvc_connection =
                           @family = @io = @ssl_session = @timeout =
                                             @connected_at = @response_received_at = nil

  @exhausted = @cloned = @main_sibling = false

  @options = Options.new(options)
  @type = initialize_type(uri, @options)
  @origins = [uri.origin]
  @origin = Utils.to_uri(uri.origin)
  @window_size = @options.window_size
  @read_buffer = Buffer.new(@options.buffer_size)
  @write_buffer = Buffer.new(@options.buffer_size)
  @pending = []
  @inflight = 0
  @keep_alive_timeout = @options.timeout[:keep_alive_timeout]

  if @options.io
    # if there's an already open IO, get its
    # peer address, and force-initiate the parser
    transition(:already_open)
    @io = build_socket
    parser
  else
    transition(:idle)
  end
  self.addresses = @options.addresses if @options.addresses
end

Instance Attribute Details

#current_selector=(value) ⇒ Object (writeonly)

Sets the attribute current_selector

Parameters:

  • value —

    the value to set the attribute current_selector to.



41
42
43
 
# File 'lib/httpx/connection.rb', line 41

def current_selector=(value)
  @current_selector = value
end

#current_session ⇒ Object

Returns the value of attribute current_session.



43
44
45
 
# File 'lib/httpx/connection.rb', line 43

def current_session
  @current_session
end

#family ⇒ Object

Returns the value of attribute family.



43
44
45
 
# File 'lib/httpx/connection.rb', line 43

def family
  @family
end

#io ⇒ Object (readonly)

Returns the value of attribute io.



39
40
41
 
# File 'lib/httpx/connection.rb', line 39

def io
  @io
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



39
40
41
 
# File 'lib/httpx/connection.rb', line 39

def options
  @options
end

#origin ⇒ Object (readonly)

Returns the value of attribute origin.



39
40
41
 
# File 'lib/httpx/connection.rb', line 39

def origin
  @origin
end

#origins ⇒ Object (readonly)

Returns the value of attribute origins.



39
40
41
 
# File 'lib/httpx/connection.rb', line 39

def origins
  @origins
end

#pending ⇒ Object (readonly)

Returns the value of attribute pending.



39
40
41
 
# File 'lib/httpx/connection.rb', line 39

def pending
  @pending
end

#sibling=(connection) ⇒ Object 



352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/httpx/connection.rb', line 352

def sibling=(connection)
  @sibling = connection

  return unless connection

  @main_sibling = connection.sibling.nil?

  return unless @main_sibling

  connection.sibling = self
end

#state ⇒ Object (readonly)

Returns the value of attribute state.



39
40
41
 
# File 'lib/httpx/connection.rb', line 39

def state
  @state
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



39
40
41
 
# File 'lib/httpx/connection.rb', line 39

def type
  @type
end

Instance Method Details

#addresses ⇒ Object 



92
93
94
 
# File 'lib/httpx/connection.rb', line 92

def addresses
  @io && @io.addresses
end

#addresses=(addrs) ⇒ Object

this is a semi-private method, to be used by the resolver to initiate the io object.



84
85
86
87
88
89
90
 
# File 'lib/httpx/connection.rb', line 84

def addresses=(addrs)
  if @io
    @io.add_addresses(addrs)
  else
    @io = build_socket(addrs)
  end
end

#addresses? ⇒ Boolean

Returns:

  • (Boolean) 


96
97
98
 
# File 'lib/httpx/connection.rb', line 96

def addresses?
  @io && @io.addresses?
end

#call ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/httpx/connection.rb', line 217

def call
  case @state
  when :idle
    connect

    # when opening the tcp or ssl socket fails
    return if @state == :closed

    consume
  when :closed
    return
  when :closing
    consume
    transition(:closed)
  when :open
    consume
  end
  nil
rescue StandardError => e
  @write_buffer.clear
  on_error(e)
rescue Exception => e # rubocop:disable Lint/RescueException
  force_close(true)
  raise e
end

#close ⇒ Object 



243
244
245
246
247
 
# File 'lib/httpx/connection.rb', line 243

def close
  transition(:active) if @state == :inactive

  @parser.close if @parser
end

#coalescable?(connection) ⇒ Boolean

coalescable connections need to be mergeable! but internally, #mergeable? is called before #coalescable?

Returns:

  • (Boolean) 


138
139
140
141
142
143
144
145
146
147
 
# File 'lib/httpx/connection.rb', line 138

def coalescable?(connection)
  if @io.protocol == "h2" &&
     @origin.scheme == "https" &&
     connection.origin.scheme == "https" &&
     @io.can_verify_peer?
    @io.verify_hostname(connection.origin.host)
  else
    @origin == connection.origin
  end
end

#coalesce!(connection) ⇒ Object

coalesces self into connection.



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

def coalesce!(connection)
  @coalesced_connection = connection

  close_sibling
  connection.merge(self)
end

#coalesced? ⇒ Boolean

Returns:

  • (Boolean) 


132
133
134
 
# File 'lib/httpx/connection.rb', line 132

def coalesced?
  @coalesced_connection
end

#connecting? ⇒ Boolean

Returns:

  • (Boolean) 


184
185
186
 
# File 'lib/httpx/connection.rb', line 184

def connecting?
  @state == :idle
end

#create_idle(options = {}) ⇒ Object 



149
150
151
 
# File 'lib/httpx/connection.rb', line 149

def create_idle(options = {})
  self.class.new(@origin, @options.merge(options))
end

#deactivate ⇒ Object 



338
339
340
 
# File 'lib/httpx/connection.rb', line 338

def deactivate
  transition(:inactive)
end

#disconnect ⇒ Object

disconnects from the current session it’s attached to



373
374
375
376
377
378
379
380
381
 
# File 'lib/httpx/connection.rb', line 373

def disconnect
  return if @exhausted # it'll reset

  return unless (current_session = @current_session) && (current_selector = @current_selector)

  @current_session = @current_selector = nil

  current_session.deselect_connection(self, current_selector, @cloned)
end

#force_close(delete_pending = false) ⇒ Object

bypasses state machine rules while setting the connection in the :closed state.



263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/httpx/connection.rb', line 263

def force_close(delete_pending = false)
  if delete_pending
    @pending.clear
  elsif (parser = @parser)
    enqueue_pending_requests_from_parser(parser)
  end
  return if @state == :closed

  @state = :closed
  @write_buffer.clear
  purge_after_closed
  disconnect
  emit(:force_closed, delete_pending)
end

#force_reset(cloned = false) ⇒ Object

bypasses the state machine to force closing of connections still connecting. only used for Happy Eyeballs v2.



280
281
282
283
284
 
# File 'lib/httpx/connection.rb', line 280

def force_reset(cloned = false)
  @state = :closing
  @cloned = cloned
  transition(:closed)
end

#handle_connect_error(error) ⇒ Object 



364
365
366
367
368
369
370
 
# File 'lib/httpx/connection.rb', line 364

def handle_connect_error(error)
  return on_error(error) unless @sibling && @sibling.connecting?

  @sibling.merge(self)

  force_reset(true)
end

#handle_socket_timeout(interval) ⇒ Object 



346
347
348
349
350
 
# File 'lib/httpx/connection.rb', line 346

def handle_socket_timeout(interval)
  error = OperationTimeoutError.new(interval, "timed out while waiting on select")
  error.set_backtrace(caller)
  on_error(error)
end

#idling ⇒ Object 



327
328
329
330
331
332
 
# File 'lib/httpx/connection.rb', line 327

def idling
  purge_after_closed
  @write_buffer.clear
  transition(:idle)
  @parser = nil if @parser
end

#inflight? ⇒ Boolean

Returns:

  • (Boolean) 


188
189
190
191
192
193
194
195
 
# File 'lib/httpx/connection.rb', line 188

def inflight?
  @parser && (
    # parser may be dealing with other requests (possibly started from a different fiber)
    !@parser.empty? ||
    # connection may be doing connection termination handshake
    !@write_buffer.empty?
  )
end

#inspect ⇒ Object

:nocov:



402
403
404
405
406
407
408
 
# File 'lib/httpx/connection.rb', line 402

def inspect
  "#<#{self.class}:#{object_id} " \
    "@origin=#{@origin} " \
    "@state=#{@state} " \
    "@pending=#{@pending.size} " \
    "@io=#{@io}>"
end

#interests ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/httpx/connection.rb', line 197

def interests
  # connecting
  if connecting?
    connect

    return @io.interests if connecting?
  end

  return @parser.interests if @parser

  nil
rescue StandardError => e
  on_error(e)
  nil
end

#io_connected? ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
181
182
 
# File 'lib/httpx/connection.rb', line 178

def io_connected?
  return @coalesced_connection.io_connected? if @coalesced_connection

  @io && @io.state == :connected
end

#match?(uri, options) ⇒ Boolean

Returns:

  • (Boolean) 


100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/httpx/connection.rb', line 100

def match?(uri, options)
  return false if !used? && (@state == :closing || @state == :closed)

  (
    @origins.include?(uri.origin) &&
    # if there is more than one origin to match, it means that this connection
    # was the result of coalescing. To prevent blind trust in the case where the
    # origin came from an ORIGIN frame, we're going to verify the hostname with the
    # SSL certificate
    (@origins.size == 1 || @origin == uri.origin || (@io.is_a?(SSL) && @io.verify_hostname(uri.host)))
  ) && @options == options
end

#merge(connection) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/httpx/connection.rb', line 153

def merge(connection)
  @origins |= connection.instance_variable_get(:@origins)
  if @ssl_session.nil? && connection.ssl_session
    @ssl_session = connection.ssl_session
    @io.session_new_cb do |sess|
      @ssl_session = sess
    end if @io
  end
  connection.purge_pending do |req|
    send(req)
  end
end

#mergeable?(connection) ⇒ Boolean

Returns:

  • (Boolean) 


113
114
115
116
117
118
119
120
121
122
 
# File 'lib/httpx/connection.rb', line 113

def mergeable?(connection)
  return false if @state == :closing || @state == :closed || !@io

  return false unless connection.addresses

  (
    (open? && @origin == connection.origin) ||
    !(@io.addresses & (connection.addresses || [])).empty?
  ) && @options == connection.options
end

#on_error(error, request = nil) ⇒ Object 



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/httpx/connection.rb', line 383

def on_error(error, request = nil)
  if error.is_a?(OperationTimeoutError)

    # inactive connections do not contribute to the select loop, therefore
    # they should not fail due to such errors.
    return if @state == :inactive

    if @timeout
      @timeout -= error.timeout
      return unless @timeout <= 0
    end

    error = error.to_connection_error if connecting?
  end
  handle_error(error, request)
  reset
end

#open? ⇒ Boolean

Returns:

  • (Boolean) 


342
343
344
 
# File 'lib/httpx/connection.rb', line 342

def open?
  @state == :open || @state == :inactive
end

#peer ⇒ Object 



78
79
80
 
# File 'lib/httpx/connection.rb', line 78

def peer
  @origin
end

#purge_pending(&block) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/httpx/connection.rb', line 166

def purge_pending(&block)
  pendings = []
  if @parser
    @inflight -= @parser.pending.size
    pendings << @parser.pending
  end
  pendings << @pending
  pendings.each do |pending|
    pending.reject!(&block)
  end
end

#reset ⇒ Object 



286
287
288
289
290
291
292
 
# File 'lib/httpx/connection.rb', line 286

def reset
  return if @state == :closing || @state == :closed

  transition(:closing)

  transition(:closed)
end

#send(request) ⇒ Object 



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/httpx/connection.rb', line 294

def send(request)
  return @coalesced_connection.send(request) if @coalesced_connection

  if @parser && !@write_buffer.full?
    if @response_received_at && @keep_alive_timeout &&
       Utils.elapsed_time(@response_received_at) > @keep_alive_timeout
      # when pushing a request into an existing connection, we have to check whether there
      # is the possibility that the connection might have extended the keep alive timeout.
      # for such cases, we want to ping for availability before deciding to shovel requests.
      log(level: 3) { "keep alive timeout expired, pinging connection..." }
      @pending << request
      transition(:active) if @state == :inactive
      parser.ping
      request.ping!
      return
    end

    send_request_to_parser(request)
  else
    @pending << request
  end
end

#terminate ⇒ Object 



249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/httpx/connection.rb', line 249

def terminate
  case @state
  when :idle
    purge_after_closed
    disconnect
  when :closed
    @connected_at = nil
  end

  close
end

#timeout ⇒ Object 



317
318
319
320
321
322
323
324
325
 
# File 'lib/httpx/connection.rb', line 317

def timeout
  return if @state == :closed || @state == :inactive

  return @timeout if @timeout

  return @options.timeout[:connect_timeout] if @state == :idle

  @options.timeout[:operation_timeout]
end

#to_io ⇒ Object 



213
214
215
 
# File 'lib/httpx/connection.rb', line 213

def to_io
  @io.to_io
end

#used? ⇒ Boolean

Returns:

  • (Boolean) 


334
335
336
 
# File 'lib/httpx/connection.rb', line 334

def used?
  @connected_at
end