Class: Async::HTTP::Client

Inherits:
Protocol::HTTP::Methods
  • Object
show all
Defined in:
lib/async/http/client.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(endpoint, protocol = endpoint.protocol, scheme = endpoint.scheme, authority = endpoint.authority, retries: 3, connection_limit: nil) ⇒ Client

Provides a robust interface to a server.

  • If there are no connections, it will create one.

  • If there are already connections, it will reuse it.

  • If a request fails, it will retry it up to N times if it was idempotent.

The client object will never become unusable. It internally manages persistent connections (or non-persistent connections if that’s required).

Parameters:

  • endpoint (Endpoint) —

    the endpoint to connnect to.

  • protocol (Protocol::HTTP1 | Protocol::HTTP2 | Protocol::HTTPS) (defaults to: endpoint.protocol) —

    the protocol to use.

  • scheme (String) (defaults to: endpoint.scheme) —

    The default scheme to set to requests.

  • authority (String) (defaults to: endpoint.authority) —

    The default authority to set to requests.



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/async/http/client.rb', line 41

def initialize(endpoint, protocol = endpoint.protocol, scheme = endpoint.scheme, authority = endpoint.authority, retries: 3, connection_limit: nil)
	@endpoint = endpoint
	@protocol = protocol
	
	@retries = retries
	@pool = make_pool(connection_limit)
	
	@scheme = scheme
	@authority = authority
end

Instance Attribute Details

#authority ⇒ Object (readonly)

Returns the value of attribute authority.



59
60
61
 
# File 'lib/async/http/client.rb', line 59

def authority
  @authority
end

#endpoint ⇒ Object (readonly)

Returns the value of attribute endpoint.



52
53
54
 
# File 'lib/async/http/client.rb', line 52

def endpoint
  @endpoint
end

#pool ⇒ Object (readonly)

Returns the value of attribute pool.



56
57
58
 
# File 'lib/async/http/client.rb', line 56

def pool
  @pool
end

#protocol ⇒ Object (readonly)

Returns the value of attribute protocol.



53
54
55
 
# File 'lib/async/http/client.rb', line 53

def protocol
  @protocol
end

#retries ⇒ Object (readonly)

Returns the value of attribute retries.



55
56
57
 
# File 'lib/async/http/client.rb', line 55

def retries
  @retries
end

#scheme ⇒ Object (readonly)

Returns the value of attribute scheme.



58
59
60
 
# File 'lib/async/http/client.rb', line 58

def scheme
  @scheme
end

Class Method Details

.open(*args, &block) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/async/http/client.rb', line 65

def self.open(*args, &block)
	client = self.new(*args)
	
	return client unless block_given?
	
	begin
		yield client
	ensure
		client.close
	end
end

Instance Method Details

#call(request) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
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
 
# File 'lib/async/http/client.rb', line 81

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 = request.call(connection)
		
		# The connection won't be released until the body is completely read/released.
		::Protocol::HTTP::Body::Streamable.wrap(response) do
			@pool.release(connection)
		end
		
		return response
	rescue Protocol::RequestFailed
		# This is a specific case where the entire request wasn't sent before a failure occurred. So, we can even resend non-idempotent requests.
		@pool.release(connection) if connection
		
		if attempt < @retries
			retry
		else
			raise
		end
	rescue
		@pool.release(connection) if connection
		
		if request.idempotent? and attempt < @retries
			retry
		else
			raise
		end
	end
end

#close ⇒ Object 



77
78
79
 
# File 'lib/async/http/client.rb', line 77

def close
	@pool.close
end

#secure? ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
 
# File 'lib/async/http/client.rb', line 61

def secure?
	@endpoint.secure?
end