class Async::HTTP::Proxy
Wraps a client, address and headers required to initiate a connectio to a remote host using the CONNECT verb. Behaves like a TCP endpoint for the purposes of connecting to a remote host.
Attributes
Public Class Methods
Construct a endpoint that will use the given client as a proxy for HTTP
requests. @param client [Async::HTTP::Client] the client which will be used as a proxy server. @param endpoint [Async::HTTP::Endpoint] the endpoint to connect to. @param headers [Array] an optional list of headers to use when establishing the connection.
# File lib/async/http/proxy.rb, line 75 def self.endpoint(client, endpoint, headers = nil) proxy = self.new(client, endpoint.authority(false), headers) return proxy.endpoint(endpoint.url) end
@param client [Async::HTTP::Client] the client which will be used as a proxy server. @param address [String] the address to connect to. @param headers [Array] an optional list of headers to use when establishing the connection.
# File lib/async/http/proxy.rb, line 84 def initialize(client, address, headers = nil) @client = client @address = address @headers = ::Protocol::HTTP::Headers[headers].freeze end
Prepare and endpoint which can establish a TCP connection to the remote system. @param client [Async::HTTP::Client] the client which will be used as a proxy server. @param host [String] the hostname or address to connect to. @param port [String] the port number to connect to. @param headers [Array] an optional list of headers to use when establishing the connection. @see Async::IO::Endpoint#tcp
# File lib/async/http/proxy.rb, line 67 def self.tcp(client, host, port, headers = nil) self.new(client, "#{host}:#{port}", headers) end
Public Instance Methods
Close the underlying client connection.
# File lib/async/http/proxy.rb, line 93 def close @client.close end
Establish a TCP connection to the specified host. @return [Socket] a connected bi-directional socket.
# File lib/async/http/proxy.rb, line 99 def connect(&block) input = Body::Writable.new response = @client.connect(@address.to_s, @headers, input) if response.success? pipe = Body::Pipe.new(response.body, input) return pipe.to_io unless block_given? begin yield pipe.to_io ensure pipe.close end else # This ensures we don't leave a response dangling: response.close raise ConnectFailure, response end end
@return [Async::HTTP::Endpoint] an endpoint that connects via the specified proxy.
# File lib/async/http/proxy.rb, line 123 def wrap_endpoint(endpoint) Endpoint.new(endpoint.url, self, **endpoint.options) end