Class Net::HTTP::Persistent
In: lib/net/http/persistent.rb
Parent: Object

Persistent connections for Net::HTTP

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.

Multiple Net::HTTP::Persistent objects will share the same set of connections.

For each thread you start a new connection will be created. A Net::HTTP::Persistent connection will not be shared across threads.

You can shut down the HTTP connections when done by calling shutdown. You should name your Net::HTTP::Persistent object if you intend to call this method.

Example:

  uri = URI.parse 'http://example.com/awesome/web/service'
  http = Net::HTTP::Persistent.new
  stuff = http.request uri # performs a GET

  # perform a POST
  post_uri = uri + 'create'
  post = Net::HTTP::Post.new post_uri.path
  post.set_form_data 'some' => 'cool data'
  http.request post_uri, post # URI is always required

Methods

Classes and Modules

Class Net::HTTP::Persistent::Error

Constants

VERSION = '1.7'   The version of Net::HTTP::Persistent use are using

Attributes

ca_file  [RW]  An SSL certificate authority. Setting this will set verify_mode to VERIFY_PEER.
certificate  [RW]  This client‘s OpenSSL::X509::Certificate
debug_output  [RW]  Sends debug_output to this IO via Net::HTTP#set_debug_output.

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

headers  [R]  Headers that are added to every request
http_versions  [R]  Maps host:port to an HTTP version. This allows us to enable version specific features.
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.

name  [R]  A name for this connection. Allows you to keep your connections apart from everybody else‘s.
open_timeout  [RW]  Seconds to wait until a connection is opened. See Net::HTTP#open_timeout
private_key  [RW]  This client‘s SSL private key
proxy_uri  [R]  The URL through which requests will be proxied
read_timeout  [RW]  Seconds to wait until reading one block. See Net::HTTP#read_timeout
socket_options  [R]  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]
verify_callback  [RW]  SSL verification callback. Used when ca_file is set.
verify_mode  [RW]  HTTPS verify mode. Defaults to OpenSSL::SSL::VERIFY_NONE which ignores certificate problems.

You can use verify_mode to override any default values.

Public Class methods

Creates a new Net::HTTP::Persistent.

Set name to keep your connections apart from everybody else‘s. Not required currently, but highly recommended. Your library name should be good enough. This parameter will be required in a future version.

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

In order to use a URI for the proxy you‘ll need to do some extra work beyond URI.parse:

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

Public Instance methods

Creates a new connection for uri

Returns an error message containing the number of requests performed on this connection

URI::escape wrapper

Finishes the Net::HTTP connection

Returns the HTTP protocol version for uri

Is req idempotent according to RFC 2616?

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

Pipelines requests to the HTTP server at uri yielding responses if a block is given. Returns all responses recieved.

See Net::HTTP::Pipeline for further details.

Only if net-http-pipeline was required before net-http-persistent pipeline will be present.

Creates a 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 URI is given the indicated user and password unless HTTP_PROXY contains either of these in the URI.

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

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

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

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

If there is an error and the request is idempontent according to RFC 2616 it will be retried automatically.

Finishes then restarts the Net::HTTP connection

Shuts down all connections for thread.

Uses the current thread by default.

If you‘ve used Net::HTTP::Persistent across multiple threads you should call this in each thread when you‘re done making HTTP requests.

NOTE: Calling shutdown for another thread can be dangerous!

If the thread is still using the connection it may cause an error! It is best to call shutdown in the thread at the appropriate time instead!

Shuts down all connections in all threads

NOTE: THIS METHOD IS VERY DANGEROUS!

Do not call this method if other threads are still using their connections! Call shutdown at the appropriate time instead!

Use this method only as a last resort!

Enables SSL on connection

[Validate]