class Async::HTTP::Client

An HTTP client that manages persistent connections to a specific endpoint, with automatic retries for idempotent requests.

def self.open(*arguments, **options, &block)

@parameter options [Hash] Options to pass to {initialize}.
@parameter arguments [Array] Arguments to pass to {initialize}.
Open a client and optionally yield it, ensuring it is closed afterwards.
def self.open(*arguments, **options, &block)
	client = self.new(*arguments, **options)
	
	return client unless block_given?
	
	begin
		yield client
	ensure
		client.close
	end
end

def as_json(...)

@returns [Hash] A JSON-compatible representation of this client.
def as_json(...)
	{
		endpoint: @endpoint.to_s,
			protocol: @protocol,
			retries: @retries,
			scheme: @scheme,
			authority: @authority,
	}
end

def assign_default_tags(tags)

def assign_default_tags(tags)
	tags[:endpoint] = @endpoint.to_s
	tags[:protocol] = @protocol.to_s
end

def call(request)

@returns [Protocol::HTTP::Response] The response from the server.
@parameter request [Protocol::HTTP::Request] The request to send.
Send a request to the remote server, with automatic retries for idempotent requests.
def call(request)
	request.scheme ||= self.scheme
	request.authority ||= self.authority
	
	attempt = 0
	
	# We may retry the request if it is possible to do so. https://tools.ietf.org/html/draft-nottingham-httpbis-retry-01 is a good guide for how retrying requests should work.
	begin
		attempt += 1
		
		# As we cache pool, it's possible these pool go bad (e.g. closed by remote host). In this case, we need to try again. It's up to the caller to impose a timeout on this. If this is the last attempt, we force a new connection.
		connection = @pool.acquire
		
		response = make_response(request, connection, attempt)
		
		# This signals that the ensure block below should not try to release the connection, because it's bound into the response which will be returned:
		connection = nil
		return response
	rescue ::Protocol::HTTP::RefusedError
		# This is a specific case where the request was not processed by the server. So, we can resend even non-idempotent requests.
		if connection
			@pool.release(connection)
			connection = nil
		end
		
		if attempt < @retries and request.rewind!
			retry
		else
			raise
		end
	rescue ::Protocol::HTTP::RemoteError, SocketError, IOError, EOFError, Errno::ECONNRESET, Errno::EPIPE
		if connection
			@pool.release(connection)
			connection = nil
		end
		
		if attempt < @retries and request.retry!
			retry
		else
			raise
		end
	ensure
		if connection
			@pool.release(connection)
		end
	end
end

def close

Close the client and all associated connections.
def close
	@pool.wait_until_free do
		Console.warn(self){"Waiting for #{@protocol} pool to drain: #{@pool}"}
	end
	
	@pool.close
end

def initialize(endpoint, protocol: endpoint.protocol, scheme: endpoint.scheme, authority: endpoint.authority, retries: DEFAULT_RETRIES, **options)

Parameters:
  • authority (String) -- The default authority to set to requests.
  • scheme (String) -- The default scheme to set to requests.
  • protocol (Protocol::HTTP1 | Protocol::HTTP2 | Protocol::HTTPS) -- the protocol to use.
  • endpoint (Endpoint) -- the endpoint to connnect to.
def initialize(endpoint, protocol: endpoint.protocol, scheme: endpoint.scheme, authority: endpoint.authority, retries: DEFAULT_RETRIES, **options)
	@endpoint = endpoint
	@protocol = protocol
	
	@retries = retries
	@pool = make_pool(**options)
	
	@scheme = scheme
	@authority = authority
end

def inspect

@returns [String] A summary of this client.
def inspect
	"#<#{self.class} authority=#{@authority.inspect}>"
end

def make_pool(**options)

def make_pool(**options)
	if connection_limit = options.delete(:connection_limit)
		warn "The connection_limit: option is deprecated, please use limit: instead.", uplevel: 2
		options[:limit] = connection_limit
	end
	
	self.assign_default_tags(options[:tags] ||= {})
	
	Async::Pool::Controller.wrap(**options) do
		Console.debug(self){"Making connection to #{@endpoint.inspect}"}
		
		@protocol.client(@endpoint.connect)
	end
end

def make_response(request, connection, attempt)

def make_response(request, connection, attempt)
	response = request.call(connection)
	
	response.pool = @pool
	
	return response
end

def secure?

@returns [Boolean] Whether the client uses a secure (TLS) connection.
def secure?
	@endpoint.secure?
end

def to_json(...)

@returns [String] A JSON string representation of this client.
def to_json(...)
	as_json.to_json(...)
end