class HTTPX::Session

  1. lib/httpx/session.rb
Superclass: Object

Class implementing the APIs being used publicly.

HTTPX.get(..) #=> delegating to an internal HTTPX::Session object.
HTTPX.plugin(..).get(..) #=> creating an intermediate HTTPX::Session with plugin, then sending the GET request

Included modules

  1. Loggable
  2. Chainable

Constants

INSTANCES = ObjectSpace::WeakMap.new  

Public Instance Aliases

select_resolver -> select_connection

Attributes

Public Class methods

after_fork()
[show source]
    # File lib/httpx/session.rb
575 def self.after_fork
576   INSTANCES.each_value(&:close)
577   nil
578 end
inherited(klass)
[show source]
    # File lib/httpx/session.rb
483 def inherited(klass)
484   super
485   klass.instance_variable_set(:@default_options, @default_options)
486   klass.instance_variable_set(:@plugins, @plugins.dup)
487   klass.instance_variable_set(:@callbacks, @callbacks.dup)
488 end
new(options = EMPTY_HASH, &blk)

initializes the session with a set of options, which will be shared by all requests sent from it.

When pass a block, it’ll yield itself to it, then closes after the block is evaluated.

[show source]
   # File lib/httpx/session.rb
16 def initialize(options = EMPTY_HASH, &blk)
17   @options = self.class.default_options.merge(options)
18   @persistent = @options.persistent
19   @pool = @options.pool_class.new(@options.pool_options)
20   @wrapped = false
21   @closing = false
22   INSTANCES[self] = self if @persistent && @options.close_on_fork && INSTANCES
23   wrap(&blk) if blk
24 end
plugin(pl, options = nil, &block)

returns a new HTTPX::Session instance, with the plugin pointed by pl loaded.

session_with_retries = session.plugin(:retries)
session_with_custom = session.plugin(CustomPlugin)
[show source]
    # File lib/httpx/session.rb
495 def plugin(pl, options = nil, &block)
496   label = pl
497   pl = Plugins.load_plugin(pl) if pl.is_a?(Symbol)
498   raise ArgumentError, "Invalid plugin type: #{pl.class.inspect}" unless pl.is_a?(Module)
499 
500   if !@plugins.include?(pl)
501     @plugins << pl
502     pl.load_dependencies(self, &block) if pl.respond_to?(:load_dependencies)
503 
504     @default_options = @default_options.dup
505 
506     include(pl::InstanceMethods) if defined?(pl::InstanceMethods)
507     extend(pl::ClassMethods) if defined?(pl::ClassMethods)
508 
509     opts = @default_options
510     opts.extend_with_plugin_classes(pl)
511 
512     if defined?(pl::OptionsMethods)
513       # when a class gets dup'ed, the #initialize_dup callbacks isn't triggered.
514       # moreover, and because #method_added does not get triggered on mixin include,
515       # the callback is also forcefully manually called here.
516       opts.options_class.instance_variable_set(:@options_names, opts.options_class.options_names.dup)
517       (pl::OptionsMethods.instance_methods + pl::OptionsMethods.private_instance_methods - Object.instance_methods).each do |meth|
518         opts.options_class.method_added(meth)
519       end
520       @default_options = opts.options_class.new(opts)
521     end
522 
523     @default_options = pl.extra_options(@default_options) if pl.respond_to?(:extra_options)
524     @default_options = @default_options.merge(options) if options
525 
526     if pl.respond_to?(:subplugins)
527       pl.subplugins.transform_keys(&Plugins.method(:load_plugin)).each do |main_pl, sub_pl|
528         # in case the main plugin has already been loaded, then apply subplugin functionality
529         # immediately
530         next unless @plugins.include?(main_pl)
531 
532         plugin(sub_pl, options, &block)
533       end
534     end
535 
536     pl.configure(self, &block) if pl.respond_to?(:configure)
537 
538     if label.is_a?(Symbol)
539       # in case an already-loaded plugin complements functionality of
540       # the plugin currently being loaded, loaded it now
541       @plugins.each do |registered_pl|
542         next if registered_pl == pl
543 
544         next unless registered_pl.respond_to?(:subplugins)
545 
546         sub_pl = registered_pl.subplugins[label]
547 
548         next unless sub_pl
549 
550         plugin(sub_pl, options, &block)
551       end
552     end
553 
554     @default_options.freeze
555     set_temporary_name("#{superclass}/#{pl}") if respond_to?(:set_temporary_name) # ruby 3.4 only
556   elsif options
557     # this can happen when two plugins are loaded, an one of them calls the other under the hood,
558     # albeit changing some default.
559     @default_options = pl.extra_options(@default_options) if pl.respond_to?(:extra_options)
560     @default_options = @default_options.merge(options) if options
561 
562     @default_options.freeze
563   end
564 
565   self
566 end

Public Instance methods

build_request(verb, uri, params = EMPTY_HASH, options = @options)

returns a HTTP::Request instance built from the HTTP verb, the request uri, and the optional set of request-specific options. This request must be sent through the same session it was built from.

req = session.build_request("GET", "https://server.com")
resp = session.request(req)
[show source]
    # File lib/httpx/session.rb
114 def build_request(verb, uri, params = EMPTY_HASH, options = @options)
115   rklass = options.request_class
116   request = rklass.new(verb, uri, options, params)
117   request.persistent = @persistent
118   set_request_callbacks(request)
119   request
120 end
close(selector = Selector.new)

closes all the active connections from the session.

when called directly without specifying selector, all available connections will be picked up from the connection pool and closed. Connections in use by other sessions, or same session in a different thread, will not be reaped.

[show source]
   # File lib/httpx/session.rb
64 def close(selector = Selector.new)
65   # throw resolvers away from the pool
66   @pool.reset_resolvers
67 
68   # preparing to throw away connections
69   while (connection = @pool.pop_connection)
70     next if connection.state == :closed
71 
72     select_connection(connection, selector)
73   end
74 
75   selector_close(selector)
76 end
deselect_connection(connection, selector, cloned = false)
[show source]
    # File lib/httpx/session.rb
137 def deselect_connection(connection, selector, cloned = false)
138   connection.log(level: 2) do
139     "deregistering connection##{connection.object_id}(#{connection.state}) from selector##{selector.object_id}"
140   end
141   selector.deregister(connection)
142 
143   return if cloned
144 
145   return if @closing && connection.state == :closed
146 
147   connection.log(level: 2) { "check-in connection##{connection.object_id}(#{connection.state}) in pool##{@pool.object_id}" }
148   @pool.checkin_connection(connection)
149 end
deselect_resolver(resolver, selector)
[show source]
    # File lib/httpx/session.rb
151 def deselect_resolver(resolver, selector)
152   resolver.log(level: 2) do
153     "deregistering resolver##{resolver.object_id}(#{resolver.state}) from selector##{selector.object_id}"
154   end
155   selector.deregister(resolver)
156 
157   return if @closing && resolver.closed?
158 
159   resolver.log(level: 2) { "check-in resolver##{resolver.object_id}(#{resolver.state}) in pool##{@pool.object_id}" }
160   @pool.checkin_resolver(resolver)
161 end
find_connection(request_uri, selector, options)

returns the HTTPX::Connection through which the request should be sent through.

[show source]
    # File lib/httpx/session.rb
179 def find_connection(request_uri, selector, options)
180   log(level: 2) { "finding connection for #{request_uri}..." }
181   if (connection = selector.find_connection(request_uri, options))
182     connection.idling if connection.state == :closed
183     connection.log(level: 2) { "found connection##{connection.object_id}(#{connection.state}) in selector##{selector.object_id}" }
184     return connection
185   end
186 
187   connection = @pool.checkout_connection(request_uri, options)
188 
189   connection.log(level: 2) { "found connection##{connection.object_id}(#{connection.state}) in pool##{@pool.object_id}" }
190 
191   case connection.state
192   when :idle
193     do_init_connection(connection, selector)
194   when :open
195     if options.io
196       select_connection(connection, selector)
197     else
198       pin(connection, selector)
199     end
200   when :closing, :closed
201     connection.idling
202     if connection.addresses?
203       select_connection(connection, selector)
204     else
205       # if addresses expired, resolve again
206       resolve_connection(connection, selector)
207     end
208   else
209     pin(connection, selector)
210   end
211 
212   connection
213 end
pin(conn_or_resolver, selector)
[show source]
    # File lib/httpx/session.rb
130 def pin(conn_or_resolver, selector)
131   conn_or_resolver.current_session = self
132   conn_or_resolver.current_selector = selector
133 end
request(*args, **params)

performs one, or multple requests; it accepts:

  1. one or multiple HTTPX::Request objects;

  2. an HTTP verb, then a sequence of URIs or URI/options tuples;

  3. one or multiple HTTP verb / uri / (optional) options tuples;

when present, the set of options kwargs is applied to all of the sent requests.

respectively returns a single HTTPX::Response response, or all of them in an Array, in the same order.

resp1 = session.request(req1)
resp1, resp2 = session.request(req1, req2)
resp1 = session.request("GET", "https://server.org/a")
resp1, resp2 = session.request("GET", ["https://server.org/a", "https://server.org/b"])
resp1, resp2 = session.request(["GET", "https://server.org/a"], ["GET", "https://server.org/b"])
resp1 = session.request("POST", "https://server.org/a", form: { "foo" => "bar" })
resp1, resp2 = session.request(["POST", "https://server.org/a", form: { "foo" => "bar" }], ["GET", "https://server.org/b"])
resp1, resp2 = session.request("GET", ["https://server.org/a", "https://server.org/b"], headers: { "x-api-token" => "TOKEN" })
[show source]
    # File lib/httpx/session.rb
 98 def request(*args, **params)
 99   raise ArgumentError, "must perform at least one request" if args.empty?
100 
101   requests = args.first.is_a?(Request) ? args : build_requests(*args, params)
102   responses = send_requests(*requests)
103   return responses.first if responses.size == 1
104 
105   responses
106 end
select_connection(connection, selector)
[show source]
    # File lib/httpx/session.rb
122 def select_connection(connection, selector)
123   pin(connection, selector)
124   connection.log(level: 2) do
125     "registering into selector##{selector.object_id}"
126   end
127   selector.register(connection)
128 end
try_clone_connection(connection, selector, family)
[show source]
    # File lib/httpx/session.rb
163 def try_clone_connection(connection, selector, family)
164   connection.family ||= family
165 
166   return connection if connection.family == family
167 
168   new_connection = connection.class.new(connection.origin, connection.options)
169 
170   new_connection.family = family
171 
172   connection.sibling = new_connection
173 
174   do_init_connection(new_connection, selector)
175   new_connection
176 end
wrap()

Yields itself the block, then closes it after the block is evaluated.

session.wrap do |http|
  http.get("https://wikipedia.com")
end # wikipedia connection closes here
[show source]
   # File lib/httpx/session.rb
31 def wrap
32   prev_wrapped = @wrapped
33   @wrapped = true
34   was_initialized = false
35   current_selector = get_current_selector do
36     selector = Selector.new
37 
38     set_current_selector(selector)
39 
40     was_initialized = true
41 
42     selector
43   end
44   begin
45     yield self
46   ensure
47     unless prev_wrapped
48       if @persistent
49         deactivate(current_selector)
50       else
51         close(current_selector)
52       end
53     end
54     @wrapped = prev_wrapped
55     set_current_selector(nil) if was_initialized
56   end
57 end