Class: HTTPX::TCP

Inherits:
Object
  • Object
show all
Includes:
Loggable
Defined in:
lib/httpx/io/tcp.rb

Direct Known Subclasses

SSL, UNIX

Constant Summary

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, #log_redact_body, #log_redact_headers

Constructor Details

#initialize(origin, addresses, options) ⇒ TCP

Returns a new instance of TCP.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/httpx/io/tcp.rb', line 15

def initialize(origin, addresses, options)
  @state = :idle
  @keep_open = false
  @addresses = []
  @ip_index = -1
  @ip = nil
  @hostname = origin.host
  @options = options
  @fallback_protocol = @options.fallback_protocol
  @port = origin.port
  @interests = :w
  if (io = @options.io)
    io =
      case io
      when Hash
        io[origin.authority]
      else
        io
      end
    raise Error, "Given IO objects do not match the request authority" unless io

    # @type var io: TCPSocket | OpenSSL::SSL::SSLSocket

    _, _, _, ip = io.addr
    @io = io
    @addresses << (@ip = Resolver::Entry.new(ip))
    @keep_open = true
    @state = :connected
  else
    add_addresses(addresses)
  end
  @ip_index = @addresses.size - 1
end

Instance Attribute Details

#addresses ⇒ Object (readonly)

Returns the value of attribute addresses.



11
12
13
 
# File 'lib/httpx/io/tcp.rb', line 11

def addresses
  @addresses
end

#interests ⇒ Object (readonly)

Returns the value of attribute interests.



11
12
13
 
# File 'lib/httpx/io/tcp.rb', line 11

def interests
  @interests
end

#ip ⇒ Object (readonly) Also known as: host

Returns the value of attribute ip.



11
12
13
 
# File 'lib/httpx/io/tcp.rb', line 11

def ip
  @ip
end

#port ⇒ Object (readonly)

Returns the value of attribute port.



11
12
13
 
# File 'lib/httpx/io/tcp.rb', line 11

def port
  @port
end

#state ⇒ Object (readonly)

Returns the value of attribute state.



11
12
13
 
# File 'lib/httpx/io/tcp.rb', line 11

def state
  @state
end

Instance Method Details

#add_addresses(addrs) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/httpx/io/tcp.rb', line 53

def add_addresses(addrs)
  return if addrs.empty?

  ip_index = @ip_index || (@addresses.size - 1)
  if addrs.first.ipv6?
    # should be the next in line
    @addresses = [*@addresses[0, ip_index], *addrs, *@addresses[ip_index..-1]]
  else
    @addresses.unshift(*addrs)
  end
  @ip_index += addrs.size
end

#addresses? ⇒ Boolean

eliminates expired entries and returns whether there are still any left.

Returns:

  • (Boolean) 


67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/httpx/io/tcp.rb', line 67

def addresses?
  prev_addr_size = @addresses.size

  @addresses.delete_if(&:expired?).sort! do |addr1, addr2|
    if addr1.ipv6?
      addr2.ipv6? ? 0 : 1
    else
      addr2.ipv6? ? -1 : 0
    end
  end

  @ip_index = @addresses.size - 1 if prev_addr_size != @addresses.size

  @addresses.any?
end

#close ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/httpx/io/tcp.rb', line 184

def close
  return if @keep_open || closed?

  begin
    @io.close
  rescue StandardError => e
    log { "error closing socket" }
    log { e.full_message(highlight: false) }
  ensure
    transition(:closed)
  end
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


201
202
203
 
# File 'lib/httpx/io/tcp.rb', line 201

def closed?
  @state == :idle || @state == :closed
end

#connect ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/httpx/io/tcp.rb', line 91

def connect
  return unless closed?

  if @addresses.empty?
    # an idle connection trying to connect with no available addresses is a connection
    # out of the initial context which is back to the DNS resolution loop. This may
    # happen in a fiber-aware context where a connection reconnects with expired addresses,
    # and context is passed back to a fiber on the same connection while waiting for the
    # DNS answer.
    log { "tried connecting while resolving, skipping..." }

    return
  end

  if !@io || @io.closed?
    transition(:idle)
    @io = build_socket
  end
  try_connect
rescue Errno::EHOSTUNREACH,
       Errno::ENETUNREACH => e
  @ip_index -= 1

  raise e if @ip_index.negative?

  log { "failed connecting to #{@ip} (#{e.message}), evict from cache and trying next..." }
  @options.resolver_cache.evict(@hostname, @ip)

  @io = build_socket
  retry
rescue Errno::ECONNREFUSED,
       Errno::EADDRNOTAVAIL,
       SocketError,
       IOError => e
  @ip_index -= 1

  raise e if @ip_index.negative?

  log { "failed connecting to #{@ip} (#{e.message}), trying next..." }
  @io = build_socket
  retry
rescue Errno::ETIMEDOUT => e
  @ip_index -= 1

  raise ConnectTimeoutError.new(@options.timeout[:connect_timeout], e.message) if @ip_index.negative?

  log { "failed connecting to #{@ip} (#{e.message}), trying next..." }

  @io = build_socket
  retry
end

#connected? ⇒ Boolean

Returns:

  • (Boolean) 


197
198
199
 
# File 'lib/httpx/io/tcp.rb', line 197

def connected?
  @state == :connected
end

#inspect ⇒ Object

:nocov:



206
207
208
209
210
211
212
213
 
# File 'lib/httpx/io/tcp.rb', line 206

def inspect
  "#<#{self.class}:#{object_id} " \
    "#{@ip}:#{@port} " \
    "@state=#{@state} " \
    "@hostname=#{@hostname} " \
    "@addresses=#{@addresses} " \
    "@state=#{@state}>"
end

#protocol ⇒ Object 



87
88
89
 
# File 'lib/httpx/io/tcp.rb', line 87

def protocol
  @fallback_protocol
end

#read(size, buffer) ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/httpx/io/tcp.rb', line 161

def read(size, buffer)
  ret = @io.read_nonblock(size, buffer, exception: false)
  if ret == :wait_readable
    buffer.clear
    return 0
  end
  return if ret.nil?

  log { "READ: #{buffer.bytesize} bytes..." }
  buffer.bytesize
end

#socket ⇒ Object 



49
50
51
 
# File 'lib/httpx/io/tcp.rb', line 49

def socket
  @io
end

#to_io ⇒ Object 



83
84
85
 
# File 'lib/httpx/io/tcp.rb', line 83

def to_io
  @io.to_io
end

#write(buffer) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/httpx/io/tcp.rb', line 173

def write(buffer)
  siz = @io.write_nonblock(buffer, exception: false)
  return 0 if siz == :wait_writable
  return if siz.nil?

  log { "WRITE: #{siz} bytes..." }

  buffer.shift!(siz)
  siz
end