Class: Gem::Net::HTTP::Persistent

Relationships & Source Files
Namespace Children
Exceptions: `Error`
Inherits:	Object
Defined in:	lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb

Overview

Persistent connections for Gem::Net::HTTP

Persistent maintains persistent connections across all the servers you wish to talk to. For each host:port you communicate with a single persistent connection is created.

Connections will be shared across threads through a connection pool to increase reuse of connections.

You can shut down any remaining HTTP connections when done by calling #shutdown.

Example:

require 'bundler/vendor/net-http-persistent/lib/net/http/persistent'

uri = Gem::URI 'http://example.com/awesome/web/service'

http = .new

# perform a GET
response = http.request uri

# or

get = Gem::Net::HTTP::Get.new uri.request_uri
response = http.request get

# create a POST
post_uri = uri + 'create'
post = Gem::Net::HTTP::Post.new post_uri.path
post.set_form_data 'some' => 'cool data'

# perform the POST, the Gem::URI is always required
response http.request post_uri, post

Note that for GET, HEAD and other requests that do not have a body you want to use Gem::URI#request_uri not Gem::URI#path. The request_uri contains the query params which are sent in the body for other requests.

TLS/SSL

TLS connections are automatically created depending upon the scheme of the Gem::URI. TLS connections are automatically verified against the default certificate store for your computer. You can override this by changing verify_mode or by specifying an alternate cert_store.

Here are the TLS settings, see the individual methods for documentation:

#certificate: This client’s certificate
#ca_file: The certificate-authorities
#ca_path: Directory with certificate-authorities
#cert_store: An SSL certificate store
#ciphers: List of SSl ciphers allowed
#private_key: The client’s SSL private key
#reuse_ssl_sessions: Reuse a previously opened SSL session for a new

connection

#ssl_timeout: Session lifetime
#ssl_version: Which specific SSL version to use
#verify_callback: For server certificate verification
#verify_depth: Depth of certificate verification
#verify_mode: How connections should be verified
#verify_hostname: Use hostname verification for server certificate

during the handshake

Proxies

A proxy can be set through #proxy= or at initialization time by providing a second argument to .new. The proxy may be the Gem::URI of the proxy server or :ENV which will consult environment variables.

See #proxy= and #proxy_from_env for details.

Headers

Headers may be specified for use in every request. #headers are appended to any headers on the request. #override_headers replace existing headers on the request.

The difference between the two can be seen in setting the User-Agent. Using http.headers['User-Agent'] = 'MyUserAgent' will send “Ruby, MyUserAgent” while http.override_headers['User-Agent'] = 'MyUserAgent' will send “MyUserAgent”.

Tuning

Segregation

Each Persistent instance has its own pool of connections. There is no sharing with other instances (as was true in earlier versions).

Idle Timeout

If a connection hasn’t been used for this number of seconds it will automatically be reset upon the next use to avoid attempting to send to a closed connection. The default value is 5 seconds. nil means no timeout. Set through #idle_timeout.

Reducing this value may help avoid the “too many connection resets” error when sending non-idempotent requests while increasing this value will cause fewer round-trips.

Read Timeout

The amount of time allowed between reading two chunks from the socket. Set through #read_timeout

Max Requests

The number of requests that should be made before opening a new connection. Typically many keep-alive capable servers tune this to 100 or less, so the 101st request will fail with ECONNRESET. If unset (default), this value has no effect, if set, connections will be reset on the request after max_requests.

Open Timeout

The amount of time to wait for a connection to be opened. Set through #open_timeout.

Socket Options

Socket options may be set on newly-created connections. See #socket_options for details.

Connection Termination

If you are done using the Persistent instance you may shut down all the connections in the current thread with #shutdown. This is not recommended for normal use, it should only be used when it will be several minutes before you make another HTTP request.

If you are using multiple threads, call #shutdown in each thread when the thread is done making requests. If you don’t call shutdown, that’s OK. Ruby will automatically garbage collect and shutdown your HTTP connections when the thread terminates.

Constant Summary

DEFAULT_POOL_SIZE =
# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 168
```
256
```
EPOCH = Internal use only

The beginning of Time

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 151
```
Time.at 0
```
HAVE_OPENSSL = Internal use only

Is OpenSSL available? This test works with autoload

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 156
```
defined? OpenSSL::SSL # :nodoc:
```
VERSION =

The version of Persistent you are using

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 179
```
'4.0.4'
```

Class Method Summary

.detect_idle_timeout(uri, max = 10)

Use this method to detect the idle timeout of the host at uri.
.new(name: nil, proxy: nil, pool_size: DEFAULT_POOL_SIZE) ⇒ Persistent constructor

Creates a new Persistent.

Instance Attribute Summary

#ca_file rw

An SSL certificate authority.
#ca_file=(file) rw

Sets the SSL certificate authority file.
#ca_path rw

A directory of SSL certificates to be used as certificate authorities.
#ca_path=(path) rw

Sets the SSL certificate authority path.
#cert rw

For Gem::Net::HTTP parity.
#cert_store rw

An SSL certificate store.
#cert_store=(store) rw

Overrides the default SSL certificate store used for verifying connections.
#certificate (also: #cert) rw

This client’s OpenSSL::X509::Certificate
#certificate=(certificate) (also: #cert=) rw

Sets this client’s OpenSSL::X509::Certificate
#ciphers rw

The ciphers allowed for SSL connections.
#ciphers=(ciphers) rw

The ciphers allowed for SSL connections.
#debug_output rw

Sends debug_output to this IO via Gem::Net::HTTP#set_debug_output.
#headers readonly

Headers that are added to every request using Gem::Net::HTTP#add_field
#http_versions readonly

Maps host:port to an HTTP version.
#idle_timeout rw

Maximum time an unused connection can remain idle before being automatically closed.
#keep_alive rw

The value sent in the Keep-Alive header.
#key rw

For Gem::Net::HTTP parity.
#max_requests rw

Maximum number of requests on a connection before it is considered expired and automatically closed.
#max_retries rw

Number of retries to perform if a request fails.
#max_retries=(retries) rw

Set the maximum number of retries for a request.
#max_version rw

Maximum SSL version to use, e.g. :TLS1_2.
#max_version=(max_version) rw

maximum SSL version to use.
#min_version rw

Minimum SSL version to use, e.g. :TLS1_1.
#min_version=(min_version) rw

Minimum SSL version to use.
#name readonly

The name for this collection of persistent connections.
#no_proxy readonly

List of host suffixes which will not be proxied.
#open_timeout rw

Seconds to wait until a connection is opened.
#override_headers readonly

Headers that are added to every request using Gem::Net::HTTP#[]=
#private_key (also: #key) rw

This client’s SSL private key.
#private_key=(key) (also: #key=) rw

Sets this client’s SSL private key.
#proxy=(proxy) writeonly

Sets the proxy server.
#proxy_uri readonly

The URL through which requests will be proxied.
#read_timeout rw

Seconds to wait until reading one block.
#reuse_ssl_sessions rw

By default SSL sessions are reused to avoid extra SSL handshakes.
#socket_options readonly

An array of options for Socket#setsockopt.
#ssl_timeout rw

SSL session lifetime.
#ssl_timeout=(ssl_timeout) rw

SSL session lifetime.
#ssl_version rw

SSL version to use.
#ssl_version=(ssl_version) rw

SSL version to use.
#verify_callback rw

SSL verification callback.
#verify_callback=(callback) rw

SSL verification callback.
#verify_depth rw

Sets the depth of SSL certificate verification.
#verify_depth=(verify_depth) rw

Sets the depth of SSL certificate verification.
#verify_hostname rw

HTTPS verify_hostname.
#verify_hostname=(verify_hostname) rw

Sets the HTTPS verify_hostname.
#verify_mode rw

HTTPS verify mode.
#verify_mode=(verify_mode) rw

Sets the HTTPS verify mode.
#write_timeout rw

Seconds to wait until writing one block.
#generation readonly Internal use only

Current connection generation.
#pool readonly Internal use only

Test-only accessor for the connection pool.
#ssl_generation readonly Internal use only

Current SSL connection generation.
#timeout_key readonly Internal use only

Where this instance’s last-use times live in the thread local variables.

Instance Method Summary

#connection_for(uri)

Creates a new connection for uri
#escape(str)

CGI.escape wrapper.
#expired?(connection) ⇒ Boolean

Returns true if the connection should be reset due to an idle timeout, or maximum request count, false otherwise.
#finish(connection)

Finishes the Gem::Net::HTTP connection
#http_version(uri)

Returns the HTTP protocol version for uri
#normalize_uri(uri)

Adds “http://” to the String uri if it is missing.
#proxy_bypass?(host, port) ⇒ Boolean

Returns true when proxy should by bypassed for host.
#proxy_from_env

Creates a Gem::URI for an HTTP proxy server from ENV variables.
#reconnect

Forces reconnection of all HTTP connections, including TLS/SSL connections.
#reconnect_ssl

Forces reconnection of only TLS/SSL connections.
#request(uri, req = nil, &block)

Makes a request on uri.
#reset(connection)

Finishes then restarts the Gem::Net::HTTP connection
#shutdown

Shuts down all connections.
#ssl(connection)

Enables SSL on connection
#start(http)

Starts the Gem::Net::HTTP connection
#unescape(str)

CGI.unescape wrapper.
#request_setup(req_or_uri) Internal use only

Creates a GET request if req_or_uri is a Gem::URI and adds headers to the request.

Constructor Details

.new(name: nil, proxy: nil, pool_size: DEFAULT_POOL_SIZE) ⇒ `Persistent`

Creates a new Persistent.

Set a #name for fun. Your library name should be good enough, but this otherwise has no purpose.

proxy may be set to a Gem::URI::HTTP or :ENV to pick up proxy options from the environment. See proxy_from_env for details.

In order to use a Gem::URI for the proxy you may need to do some extra work beyond Gem::URI parsing if the proxy requires a password:

proxy = Gem::URI 'http://proxy.example'
proxy.user     = 'AzureDiamond'
proxy.password = 'hunter2'

Set pool_size to limit the maximum number of connections allowed. Defaults to 1/4 the number of allowed file handles or 256 if your OS does not support a limit on allowed file handles. You can have no more than this many threads with active HTTP transactions.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 490


def initialize name: nil, proxy: nil, pool_size: DEFAULT_POOL_SIZE
  @name = name

  @debug_output     = nil
  @proxy_uri        = nil
  @no_proxy         = []
  @headers          = {}
  @override_headers = {}
  @http_versions    = {}
  @keep_alive       = 30
  @open_timeout     = nil
  @read_timeout     = nil
  @write_timeout    = nil
  @idle_timeout     = 5
  @max_requests     = nil
  @max_retries      = 1
  @socket_options   = []
  @ssl_generation   = 0 # incremented when SSL session variables change

  @socket_options << [Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1] if
    Socket.const_defined? :TCP_NODELAY

  @pool = Gem::Net::HTTP::Persistent::Pool.new size: pool_size do |http_args|
    Gem::Net::HTTP::Persistent::Connection.new Gem::Net::HTTP, http_args, @ssl_generation
  end

  @certificate        = nil
  @ca_file            = nil
  @ca_path            = nil
  @ciphers            = nil
  @private_key        = nil
  @ssl_timeout        = nil
  @ssl_version        = nil
  @min_version        = nil
  @max_version        = nil
  @verify_callback    = nil
  @verify_depth       = nil
  @verify_mode        = nil
  @verify_hostname    = nil
  @cert_store         = nil

  @generation         = 0 # incremented when proxy Gem::URI changes

  if HAVE_OPENSSL then
    @verify_mode        = OpenSSL::SSL::VERIFY_PEER
    @reuse_ssl_sessions = OpenSSL::SSL.const_defined? :Session
  end

  self.proxy = proxy if proxy
end

Class Method Details

.detect_idle_timeout(uri, max = 10)

Use this method to detect the idle timeout of the host at uri. The value returned can be used to configure #idle_timeout. max controls the maximum idle timeout to detect.

After

Idle timeout detection is performed by creating a connection then performing a HEAD request in a loop until the connection terminates waiting one additional second per loop.

NOTE: This may not work on ruby > 1.9.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 201


def self.detect_idle_timeout uri, max = 10
  uri = Gem::URI uri unless Gem::URI::Generic === uri
  uri += '/'

  req = Gem::Net::HTTP::Head.new uri.request_uri

  http = new 'net-http-persistent detect_idle_timeout'

  http.connection_for uri do |connection|
    sleep_time = 0

    http = connection.http

    loop do
      response = http.request req

      $stderr.puts "HEAD #{uri} => #{response.code}" if $DEBUG

      unless Gem::Net::HTTPOK === response then
        raise Error, "bad response code #{response.code} detecting idle timeout"
      end

      break if sleep_time >= max

      sleep_time += 1

      $stderr.puts "sleeping #{sleep_time}" if $DEBUG
      sleep sleep_time
    end
  end
rescue
  # ignore StandardErrors, we've probably found the idle timeout.
ensure
  return sleep_time unless $!
end

Instance Attribute Details

#ca_file (rw)

An SSL certificate authority. Setting this will set verify_mode to VERIFY_PEER.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 251


attr_reader :ca_file

#ca_file=(file) (rw)

Sets the SSL certificate authority file.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 556


def ca_file= file
  @ca_file = file

  reconnect_ssl
end

#ca_path (rw)

A directory of SSL certificates to be used as certificate authorities. Setting this will set verify_mode to VERIFY_PEER.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 257


attr_reader :ca_path

#ca_path=(path) (rw)

Sets the SSL certificate authority path.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 565


def ca_path= path
  @ca_path = path

  reconnect_ssl
end

#cert (rw)

For Gem::Net::HTTP parity

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 245


alias cert certificate

#cert_store (rw)

An SSL certificate store. Setting this will override the default certificate store. See verify_mode for more information.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 263


attr_reader :cert_store

#cert_store=(store) (rw)

Overrides the default SSL certificate store used for verifying connections.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 575


def cert_store= store
  @cert_store = store

  reconnect_ssl
end

#certificate (rw) Also known as: #cert

This client’s OpenSSL::X509::Certificate

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 240


attr_reader :certificate

#certificate=(certificate) (rw) Also known as: #cert=

Sets this client’s OpenSSL::X509::Certificate

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 544


def certificate= certificate
  @certificate = certificate

  reconnect_ssl
end

#ciphers (rw)

The ciphers allowed for SSL connections

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 268


attr_reader :ciphers

#ciphers=(ciphers) (rw)

The ciphers allowed for SSL connections

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 584


def ciphers= ciphers
  @ciphers = ciphers

  reconnect_ssl
end

#debug_output (rw)

Sends debug_output to this IO via Gem::Net::HTTP#set_debug_output.

Never use this method in production code, it causes a serious security hole.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 276


attr_accessor :debug_output

#generation (readonly)

This method is for internal use only.

Current connection generation

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 281


attr_reader :generation # :nodoc:

#headers (readonly)

Headers that are added to every request using Gem::Net::HTTP#add_field

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 286


attr_reader :headers

#http_versions (readonly)

Maps host:port to an HTTP version. This allows us to enable version specific features.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 292


attr_reader :http_versions

#idle_timeout (rw)

Maximum time an unused connection can remain idle before being automatically closed.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 298


attr_accessor :idle_timeout

#keep_alive (rw)

The value sent in the Keep-Alive header. Defaults to 30. Not needed for HTTP/1.1 servers.

This may not work correctly for HTTP/1.0 servers

This method may be removed in a future version as RFC 2616 does not require this header.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 322


attr_accessor :keep_alive

#key (rw)

For Gem::Net::HTTP parity

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 347


alias key private_key

#max_requests (rw)

Maximum number of requests on a connection before it is considered expired and automatically closed.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 304


attr_accessor :max_requests

#max_retries (rw)

Number of retries to perform if a request fails.

See also #max_retries=, Gem::Net::HTTP#max_retries=.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 311


attr_reader :max_retries

#max_retries=(retries) (rw)

Set the maximum number of retries for a request.

Defaults to one retry.

Set this to 0 to disable retries.

Raises:

(ArgumentError)

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 728


def max_retries= retries
  retries = retries.to_int

  raise ArgumentError, "max_retries must be positive" if retries < 0

  @max_retries = retries

  reconnect
end

#max_version (rw)

Maximum SSL version to use, e.g. :TLS1_2

By default, the version will be negotiated automatically between client and server. Ruby 2.5 and newer only.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 426


attr_reader :max_version

#max_version=(max_version) (rw)

maximum SSL version to use

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 1063


def max_version= max_version
  @max_version = max_version

  reconnect_ssl
end

#min_version (rw)

Minimum SSL version to use, e.g. :TLS1_1

By default, the version will be negotiated automatically between client and server. Ruby 2.5 and newer only.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 418


attr_reader :min_version

#min_version=(min_version) (rw)

Minimum SSL version to use

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 1054


def min_version= min_version
  @min_version = min_version

  reconnect_ssl
end

#name (readonly)

The name for this collection of persistent connections.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 327


attr_reader :name

#no_proxy (readonly)

List of host suffixes which will not be proxied

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 357


attr_reader :no_proxy

#open_timeout (rw)

Seconds to wait until a connection is opened. See Gem::Net::HTTP#open_timeout

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 332


attr_accessor :open_timeout

#override_headers (readonly)

Headers that are added to every request using Gem::Net::HTTP#[]=

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 337


attr_reader :override_headers

#pool (readonly)

This method is for internal use only.

Test-only accessor for the connection pool

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 362


attr_reader :pool # :nodoc:

#private_key (rw) Also known as: #key

This client’s SSL private key

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 342


attr_reader :private_key

#private_key=(key) (rw) Also known as: #key=

Sets this client’s SSL private key

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 741


def private_key= key
  @private_key = key

  reconnect_ssl
end

#proxy=(proxy) (writeonly)

Sets the proxy server. The proxy may be the Gem::URI of the proxy server, the symbol :ENV which will read the proxy from the environment or nil to disable use of a proxy. See #proxy_from_env for details on setting the proxy from the environment.

If the proxy Gem::URI is set after requests have been made, the next request will shut-down and re-open all connections.

The #no_proxy query parameter can be used to specify hosts which shouldn’t be reached via proxy; if set it should be a comma separated list of hostname suffixes, optionally with :port appended, for example example.com,some.host:8080.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 764


def proxy= proxy
  @proxy_uri = case proxy
               when :ENV      then proxy_from_env
               when Gem::URI::HTTP then proxy
               when nil       then # ignore
               else raise ArgumentError, 'proxy must be :ENV or a Gem::URI::HTTP'
               end

  @no_proxy.clear

  if @proxy_uri then
    @proxy_args = [
      @proxy_uri.hostname,
      @proxy_uri.port,
      unescape(@proxy_uri.user),
      unescape(@proxy_uri.password),
    ]

    @proxy_connection_id = [nil, *@proxy_args].join ':'

    if @proxy_uri.query then
      @no_proxy = CGI.parse(@proxy_uri.query)['no_proxy'].join(',').downcase.split(',').map { |x| x.strip }.reject { |x| x.empty? }
    end
  end

  reconnect
  reconnect_ssl
end

#proxy_uri (readonly)

The URL through which requests will be proxied

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 352


attr_reader :proxy_uri

#read_timeout (rw)

Seconds to wait until reading one block. See Gem::Net::HTTP#read_timeout

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 367


attr_accessor :read_timeout

#reuse_ssl_sessions (rw)

By default SSL sessions are reused to avoid extra SSL handshakes. Set this to false if you have problems communicating with an HTTPS server like:

SSL_connect [...] read finished A: unexpected message (OpenSSL::SSL::SSLError)

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 381


attr_accessor :reuse_ssl_sessions

#socket_options (readonly)

An array of options for Socket#setsockopt.

By default the TCP_NODELAY option is set on sockets.

To set additional options append them to this array:

http.socket_options << [Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, 1]

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 392


attr_reader :socket_options

#ssl_generation (readonly)

This method is for internal use only.

Current SSL connection generation

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 397


attr_reader :ssl_generation # :nodoc:

#ssl_timeout (rw)

SSL session lifetime

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 402


attr_reader :ssl_timeout

#ssl_timeout=(ssl_timeout) (rw)

SSL session lifetime

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 1036


def ssl_timeout= ssl_timeout
  @ssl_timeout = ssl_timeout

  reconnect_ssl
end

#ssl_version (rw)

SSL version to use.

By default, the version will be negotiated automatically between client and server. Ruby 1.9 and newer only. Deprecated since Ruby 2.5.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 410


attr_reader :ssl_version

#ssl_version=(ssl_version) (rw)

SSL version to use

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 1045


def ssl_version= ssl_version
  @ssl_version = ssl_version

  reconnect_ssl
end

#timeout_key (readonly)

This method is for internal use only.

Where this instance’s last-use times live in the thread local variables

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 431


attr_reader :timeout_key # :nodoc:

#verify_callback (rw)

SSL verification callback. Used when ca_file or ca_path is set.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 436


attr_reader :verify_callback

#verify_callback=(callback) (rw)

SSL verification callback.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 1103


def verify_callback= callback
  @verify_callback = callback

  reconnect_ssl
end

#verify_depth (rw)

Sets the depth of SSL certificate verification

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 441


attr_reader :verify_depth

#verify_depth=(verify_depth) (rw)

Sets the depth of SSL certificate verification

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 1072


def verify_depth= verify_depth
  @verify_depth = verify_depth

  reconnect_ssl
end

#verify_hostname (rw)

HTTPS verify_hostname.

If a client sets this to true and enables SNI with SSLSocket#hostname=, the hostname verification on the server certificate is performed automatically during the handshake using OpenSSL::SSL.verify_certificate_identity().

You can set verify_hostname as true to use hostname verification during the handshake.

NOTE: This works with Ruby > 3.0.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 467


attr_reader :verify_hostname

#verify_hostname=(verify_hostname) (rw)

Sets the HTTPS verify_hostname.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 1094


def verify_hostname= verify_hostname
  @verify_hostname = verify_hostname

  reconnect_ssl
end

#verify_mode (rw)

HTTPS verify mode. Defaults to OpenSSL::SSL::VERIFY_PEER which verifies the server certificate.

If no ca_file, ca_path or cert_store is set the default system certificate store is used.

You can use verify_mode to override any default values.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 452


attr_reader :verify_mode

#verify_mode=(verify_mode) (rw)

Sets the HTTPS verify mode. Defaults to OpenSSL::SSL::VERIFY_PEER.

Setting this to VERIFY_NONE is a VERY BAD IDEA and should NEVER be used. Securely transfer the correct certificate and update the default certificate store or set the ca file instead.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 1085


def verify_mode= verify_mode
  @verify_mode = verify_mode

  reconnect_ssl
end

#write_timeout (rw)

Seconds to wait until writing one block. See Gem::Net::HTTP#write_timeout

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 372


attr_accessor :write_timeout

Instance Method Details

#connection_for(uri)

Creates a new connection for uri

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 593


def connection_for uri
  use_ssl = uri.scheme.downcase == 'https'

  net_http_args = [uri.hostname, uri.port]

  # I'm unsure if uri.host or uri.hostname should be checked against
  # the proxy bypass list.
  if @proxy_uri and not proxy_bypass? uri.host, uri.port then
    net_http_args.concat @proxy_args
  else
    net_http_args.concat [nil, nil, nil, nil]
  end

  connection = @pool.checkout net_http_args

  http = connection.http

  connection.ressl @ssl_generation if
    connection.ssl_generation != @ssl_generation

  if not http.started? then
    ssl   http if use_ssl
    start http
  elsif expired? connection then
    reset connection
  end

  http.keep_alive_timeout = @idle_timeout  if @idle_timeout
  http.max_retries        = @max_retries   if http.respond_to?(:max_retries=)
  http.read_timeout       = @read_timeout  if @read_timeout
  http.write_timeout      = @write_timeout if
    @write_timeout && http.respond_to?(:write_timeout=)

  return yield connection
rescue Errno::ECONNREFUSED
  if http.proxy?
    address = http.proxy_address
    port    = http.proxy_port
  else
    address = http.address
    port    = http.port
  end

  raise Error, "connection refused: #{address}:#{port}"
rescue Errno::EHOSTDOWN
  if http.proxy?
    address = http.proxy_address
    port    = http.proxy_port
  else
    address = http.address
    port    = http.port
  end

  raise Error, "host down: #{address}:#{port}"
ensure
  @pool.checkin net_http_args
end

#escape(str)

CGI.escape wrapper

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 654


def escape str
  CGI.escape str if str
end

#expired?(connection) ⇒ `Boolean`

Returns true if the connection should be reset due to an idle timeout, or maximum request count, false otherwise.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 670


def expired? connection
  return true  if     @max_requests && connection.requests >= @max_requests
  return false unless @idle_timeout
  return true  if     @idle_timeout.zero?

  Time.now - connection.last_use > @idle_timeout
end

#finish(connection)

Finishes the Gem::Net::HTTP connection

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 699


def finish connection
  connection.finish

  connection.http.instance_variable_set :@last_communicated, nil
  connection.http.instance_variable_set :@ssl_session, nil unless
    @reuse_ssl_sessions
end

#http_version(uri)

Returns the HTTP protocol version for uri

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 710


def http_version uri
  @http_versions["#{uri.hostname}:#{uri.port}"]
end

#normalize_uri(uri)

Adds “http://” to the String uri if it is missing.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 717


def normalize_uri uri
  (uri =~ /^https?:/) ? uri : "http://#{uri}"
end

#proxy_bypass?(host, port) ⇒ `Boolean`

Returns true when proxy should by bypassed for host.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 838


def proxy_bypass? host, port
  host = host.downcase
  host_port = [host, port].join ':'

  @no_proxy.each do |name|
    return true if host[-name.length, name.length] == name or
       host_port[-name.length, name.length] == name
  end

  false
end

#proxy_from_env

Creates a Gem::URI for an HTTP proxy server from ENV variables.

If HTTP_PROXY is set a proxy will be returned.

If HTTP_PROXY_USER or HTTP_PROXY_PASS are set the Gem::URI is given the indicated user and password unless HTTP_PROXY contains either of these in the Gem::URI.

The NO_PROXY ENV variable can be used to specify hosts which shouldn’t be reached via proxy; if set it should be a comma separated list of hostname suffixes, optionally with :port appended, for example example.com,some.host:8080. When set to * no proxy will be returned.

For Windows users, lowercase ENV variables are preferred over uppercase ENV variables.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 811


def proxy_from_env
  env_proxy = ENV['http_proxy'] || ENV['HTTP_PROXY']

  return nil if env_proxy.nil? or env_proxy.empty?

  uri = Gem::URI normalize_uri env_proxy

  env_no_proxy = ENV['no_proxy'] || ENV['NO_PROXY']

  # '*' is special case for always bypass
  return nil if env_no_proxy == '*'

  if env_no_proxy then
    uri.query = "no_proxy=#{escape(env_no_proxy)}"
  end

  unless uri.user or uri.password then
    uri.user     = escape ENV['http_proxy_user'] || ENV['HTTP_PROXY_USER']
    uri.password = escape ENV['http_proxy_pass'] || ENV['HTTP_PROXY_PASS']
  end

  uri
end

#reconnect

Forces reconnection of all HTTP connections, including TLS/SSL connections.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 854


def reconnect
  @generation += 1
end

#reconnect_ssl

Forces reconnection of only TLS/SSL connections.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 861


def reconnect_ssl
  @ssl_generation += 1
end

#request(uri, req = nil, &block)

Makes a request on uri. If req is nil a Gem::Net::HTTP::Get is performed against uri.

If a block is passed #request behaves like Gem::Net::HTTP#request (the body of the response will not have been read).

req must be a Gem::Net::HTTPGenericRequest subclass (see Gem::Net::HTTP for a list).

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 893


def request uri, req = nil, &block
  uri      = Gem::URI uri
  req      = request_setup req || uri
  response = nil

  connection_for uri do |connection|
    http = connection.http

    begin
      connection.requests += 1

      response = http.request req, &block

      if req.connection_close? or
        (response.http_version <= '1.0' and
          not response.connection_keep_alive?) or
          response.connection_close? then
        finish connection
      end
    rescue Exception # make sure to close the connection when it was interrupted
      finish connection

      raise
    ensure
      connection.last_use = Time.now
    end
  end

  @http_versions["#{uri.hostname}:#{uri.port}"] ||= response.http_version

  response
end

#request_setup(req_or_uri)

This method is for internal use only.

Creates a GET request if req_or_uri is a Gem::URI and adds headers to the request.

Returns the request.

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 932


def request_setup req_or_uri # :nodoc:
  req = if req_or_uri.respond_to? 'request_uri' then
          Gem::Net::HTTP::Get.new req_or_uri.request_uri
        else
          req_or_uri
        end

  @headers.each do |pair|
    req.add_field(*pair)
  end

  @override_headers.each do |name, value|
    req[name] = value
  end

  unless req['Connection'] then
    req.add_field 'Connection', 'keep-alive'
    req.add_field 'Keep-Alive', @keep_alive
  end

  req
end

#reset(connection)

Finishes then restarts the Gem::Net::HTTP connection

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 868


def reset connection
  http = connection.http

  finish connection

  start http
rescue Errno::ECONNREFUSED
  e = Error.new "connection refused: #{http.address}:#{http.port}"
  e.set_backtrace $@
  raise e
rescue Errno::EHOSTDOWN
  e = Error.new "host down: #{http.address}:#{http.port}"
  e.set_backtrace $@
  raise e
end

#shutdown

Shuts down all connections

NOTE: Calling shutdown for can be dangerous!

If any thread is still using a connection it may cause an error! Call #shutdown when you are completely done making requests!

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 963


def shutdown
  @pool.shutdown { |http| http.finish }
end

#ssl(connection)

Enables SSL on connection

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 970


def ssl connection
  connection.use_ssl = true

  connection.ciphers     = @ciphers     if @ciphers
  connection.ssl_timeout = @ssl_timeout if @ssl_timeout
  connection.ssl_version = @ssl_version if @ssl_version
  connection.min_version = @min_version if @min_version
  connection.max_version = @max_version if @max_version

  connection.verify_depth    = @verify_depth
  connection.verify_mode     = @verify_mode
  connection.verify_hostname = @verify_hostname if
    @verify_hostname != nil && connection.respond_to?(:verify_hostname=)

  if OpenSSL::SSL::VERIFY_PEER == OpenSSL::SSL::VERIFY_NONE and
     not Object.const_defined?(:I_KNOW_THAT_OPENSSL_VERIFY_PEER_EQUALS_VERIFY_NONE_IS_WRONG) then
    warn <<-WARNING
                           !!!SECURITY WARNING!!!

The SSL HTTP connection to:

#{connection.address}:#{connection.port}

                         !!!MAY NOT BE VERIFIED!!!

On your platform your OpenSSL implementation is broken.

There is no difference between the values of VERIFY_NONE and VERIFY_PEER.

This means that attempting to verify the security of SSL connections may not
work.  This exposes you to man-in-the-middle exploits, snooping on the
contents of your connection and other dangers to the security of your data.

To disable this warning define the following constant at top-level in your
application:

I_KNOW_THAT_OPENSSL_VERIFY_PEER_EQUALS_VERIFY_NONE_IS_WRONG = nil

    WARNING
  end

  connection.ca_file = @ca_file if @ca_file
  connection.ca_path = @ca_path if @ca_path

  if @ca_file or @ca_path then
    connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
    connection.verify_callback = @verify_callback if @verify_callback
  end

  if @certificate and @private_key then
    connection.cert = @certificate
    connection.key  = @private_key
  end

  connection.cert_store = if @cert_store then
                            @cert_store
                          else
                            store = OpenSSL::X509::Store.new
                            store.set_default_paths
                            store
                          end
end

#start(http)

Starts the Gem::Net::HTTP connection

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 681


def start http
  http.set_debug_output @debug_output if @debug_output
  http.open_timeout = @open_timeout if @open_timeout

  http.start

  socket = http.instance_variable_get :@socket

  if socket then # for fakeweb
    @socket_options.each do |option|
      socket.io.setsockopt(*option)
    end
  end
end

#unescape(str)

CGI.unescape wrapper

[ GitHub ]

# File 'lib/bundler/vendor/net-http-persistent/lib/net/http/persistent.rb', line 661


def unescape str
  CGI.unescape str if str
end

Class: Gem::Net::HTTP::Persistent

Overview

TLS/SSL

Proxies

Headers

Tuning

Segregation

Idle Timeout

Read Timeout

Max Requests

Open Timeout

Socket Options

Connection Termination

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(name: nil, proxy: nil, pool_size: DEFAULT_POOL_SIZE) ⇒ Persistent

Class Method Details

.detect_idle_timeout(uri, max = 10)

Instance Attribute Details

#ca_file (rw)

#ca_file=(file) (rw)

#ca_path (rw)

#ca_path=(path) (rw)

#cert (rw)

#cert_store (rw)

#cert_store=(store) (rw)

#certificate (rw) Also known as: #cert

#certificate=(certificate) (rw) Also known as: #cert=

#ciphers (rw)

#ciphers=(ciphers) (rw)

#debug_output (rw)

#generation (readonly)

#headers (readonly)

#http_versions (readonly)

#idle_timeout (rw)

#keep_alive (rw)

#key (rw)

#max_requests (rw)

#max_retries (rw)

#max_retries=(retries) (rw)

#max_version (rw)

#max_version=(max_version) (rw)

#min_version (rw)

#min_version=(min_version) (rw)

#name (readonly)

#no_proxy (readonly)

#open_timeout (rw)

#override_headers (readonly)

#pool (readonly)

#private_key (rw) Also known as: #key

#private_key=(key) (rw) Also known as: #key=

#proxy=(proxy) (writeonly)

#proxy_uri (readonly)

#read_timeout (rw)

#reuse_ssl_sessions (rw)

#socket_options (readonly)

#ssl_generation (readonly)

#ssl_timeout (rw)

#ssl_timeout=(ssl_timeout) (rw)

#ssl_version (rw)

#ssl_version=(ssl_version) (rw)

#timeout_key (readonly)

#verify_callback (rw)

#verify_callback=(callback) (rw)

#verify_depth (rw)

#verify_depth=(verify_depth) (rw)

#verify_hostname (rw)

#verify_hostname=(verify_hostname) (rw)

#verify_mode (rw)

#verify_mode=(verify_mode) (rw)

#write_timeout (rw)

Instance Method Details

#connection_for(uri)

#escape(str)

#expired?(connection) ⇒ Boolean

#finish(connection)

#http_version(uri)

.new(name: nil, proxy: nil, pool_size: DEFAULT_POOL_SIZE) ⇒ `Persistent`

#expired?(connection) ⇒ `Boolean`

#proxy_bypass?(host, port) ⇒ `Boolean`