Methods
D
P
A
B
C
D
E
F
G
H
I
K
L
M
N
O
P
R
S
T
U
V
Constants
SSL_ATTRIBUTES = %w( ssl_version key cert ca_file ca_path cert_store ciphers verify_mode verify_callback verify_depth ssl_timeout )
 
Attributes
[R] proxy_address

Address of proxy host. If Net::HTTP does not use a proxy, nil.

[R] proxy_pass

User password for accessing proxy. If Net::HTTP does not use a proxy, nil.

[R] proxy_port

Port number of proxy host. If Net::HTTP does not use a proxy, nil.

[R] proxy_user

User name for accessing proxy. If Net::HTTP does not use a proxy, nil.

[R] address

The DNS host name or IP address to connect to.

[RW] ca_file

Sets path of a CA certification file in PEM format.

The file can contain several CA certificates.

[RW] ca_path

Sets path of a CA certification directory containing certifications in PEM format.

[RW] cert

Sets an OpenSSL::X509::Certificate object as client certificate. (This method is appeared in Michal Rokos's OpenSSL extension).

[RW] cert_store

Sets the X509::Store to verify peer certificate.

[RW] ciphers

Sets the available ciphers. See OpenSSL::SSL::SSLContext#ciphers=

[RW] close_on_empty_response
[R] continue_timeout

Seconds to wait for 100 Continue response. If the HTTP object does not receive a response in this many seconds it sends the request body. The default value is nil.

[RW] key

Sets an OpenSSL::PKey::RSA or OpenSSL::PKey::DSA object. (This method is appeared in Michal Rokos's OpenSSL extension.)

[RW] open_timeout

Number of seconds to wait for the connection to open. Any number may be used, including Floats for fractional seconds. If the HTTP object cannot open a connection in this many seconds, it raises a TimeoutError exception. The default value is nil.

[R] port

The port number to connect to.

[R] read_timeout

Number of seconds to wait for one block to be read (via one read(2) call). Any number may be used, including Floats for fractional seconds. If the HTTP object cannot read data in this many seconds, it raises a TimeoutError exception. The default value is 60 seconds.

[RW] ssl_timeout

Sets the SSL timeout seconds.

[RW] ssl_version

Sets the SSL version. See OpenSSL::SSL::SSLContext#ssl_version=

[RW] verify_callback

Sets the verify callback for the server certification verification.

[RW] verify_depth

Sets the maximum depth for the certificate chain verification.

[RW] verify_mode

Sets the flags for server the certification verification at beginning of SSL/TLS session.

OpenSSL::SSL::VERIFY_NONE or OpenSSL::SSL::VERIFY_PEER are acceptable.

Class Public methods
Proxy(p_addr, p_port = nil, p_user = nil, p_pass = nil)

Creates an HTTP proxy class which behaves like Net::HTTP, but performs all access via the specified proxy.

The arguments are the DNS name or IP address of the proxy host, the port to use to access the proxy, and a username and password if authorization is required to use the proxy.

You can replace any use of the Net::HTTP class with use of the proxy class created.

If p_addr is nil, this method returns self (a Net::HTTP object).

# Example
proxy_class = Net::HTTP::Proxy('proxy.example.com', 8080)

proxy_class.start('www.ruby-lang.org') {|http|
  # connecting proxy.foo.org:8080
}

You may use them to work with authorization-enabled proxies:

proxy_host = 'your.proxy.example'
proxy_port = 8080
proxy_user = 'user'
proxy_pass = 'pass'

proxy = Net::HTTP::Proxy(proxy_host, proxy_port, proxy_user, proxy_pass)
proxy.start('www.example.com') { |http|
  # always connect to your.proxy.example:8080 using specified username
  # and password
}

Note that net/http does not use the HTTP_PROXY environment variable. If you want to use a proxy, you must set it explicitly.

# File ../ruby/lib/net/http.rb, line 880
def HTTP.Proxy(p_addr, p_port = nil, p_user = nil, p_pass = nil)
  return self unless p_addr
  delta = ProxyDelta
  proxyclass = Class.new(self)
  proxyclass.module_eval {
    include delta
    # with proxy
    @is_proxy_class = true
    @proxy_address = p_addr
    @proxy_port    = p_port || default_port()
    @proxy_user    = p_user
    @proxy_pass    = p_pass
  }
  proxyclass
end
default_port()

The default port to use for HTTP requests; defaults to 80.

# File ../ruby/lib/net/http.rb, line 492
def HTTP.default_port
  http_default_port()
end
get(uri_or_host, path = nil, port = nil)

Sends a GET request to the target and returns the HTTP response as a string. The target can either be specified as (uri), or as (host, path, port = 80); so:

print Net::HTTP.get(URI('http://www.example.com/index.html'))

or:

print Net::HTTP.get('www.example.com', '/index.html')
# File ../ruby/lib/net/http.rb, line 430
def HTTP.get(uri_or_host, path = nil, port = nil)
  get_response(uri_or_host, path, port).body
end
get_print(uri_or_host, path = nil, port = nil)

Gets the body text from the target and outputs it to $stdout. The target can either be specified as (uri), or as (host, path, port = 80); so:

Net::HTTP.get_print URI('http://www.example.com/index.html')

or:

Net::HTTP.get_print 'www.example.com', '/index.html'
# File ../ruby/lib/net/http.rb, line 411
def HTTP.get_print(uri_or_host, path = nil, port = nil)
  get_response(uri_or_host, path, port) {|res|
    res.read_body do |chunk|
      $stdout.print chunk
    end
  }
  nil
end
get_response(uri_or_host, path = nil, port = nil, &block)

Sends a GET request to the target and returns the HTTP response as a Net::HTTPResponse object. The target can either be specified as (uri), or as (host, path, port = 80); so:

res = Net::HTTP.get_response(URI('http://www.example.com/index.html'))
print res.body

or:

res = Net::HTTP.get_response('www.example.com', '/index.html')
print res.body
# File ../ruby/lib/net/http.rb, line 446
def HTTP.get_response(uri_or_host, path = nil, port = nil, &block)
  if path
    host = uri_or_host
    new(host, port || HTTP.default_port).start {|http|
      return http.request_get(path, &block)
    }
  else
    uri = uri_or_host
    new(uri.hostname, uri.port).start {|http|
      return http.request_get(uri.request_uri, &block)
    }
  end
end
http_default_port()

The default port to use for HTTP requests; defaults to 80.

# File ../ruby/lib/net/http.rb, line 497
def HTTP.http_default_port
  80
end
https_default_port()

The default port to use for HTTPS requests; defaults to 443.

# File ../ruby/lib/net/http.rb, line 502
def HTTP.https_default_port
  443
end
is_version_1_2?()
Alias for: version_1_2?
new(address, port = nil, p_addr = nil, p_port = nil, p_user = nil, p_pass = nil)

Creates a new Net::HTTP object without opening a TCP connection or HTTP session. The address should be a DNS hostname or IP address. If p_addr is given, creates a Net::HTTP object with proxy support.

Also aliased as: newobj
# File ../ruby/lib/net/http.rb, line 568
def HTTP.new(address, port = nil, p_addr = nil, p_port = nil, p_user = nil, p_pass = nil)
  Proxy(p_addr, p_port, p_user, p_pass).newobj(address, port)
end
new(address, port = nil)

Creates a new Net::HTTP object for the specified server address, without opening the TCP connection or initializing the HTTP session. The address should be a DNS hostname or IP address.

# File ../ruby/lib/net/http.rb, line 575
def initialize(address, port = nil)
  @address = address
  @port    = (port || HTTP.default_port)
  @curr_http_version = HTTPVersion
  @no_keepalive_server = false
  @close_on_empty_response = false
  @socket  = nil
  @started = false
  @open_timeout = nil
  @read_timeout = 60
  @continue_timeout = nil
  @debug_output = nil
  @use_ssl = false
  @ssl_context = nil
  @enable_post_connection_check = true
  @compression = nil
  @sspi_enabled = false
  if defined?(SSL_ATTRIBUTES)
    SSL_ATTRIBUTES.each do |name|
      instance_variable_set "@#{name}", nil
    end
  end
end
newobj(address, port = nil, p_addr = nil, p_port = nil, p_user = nil, p_pass = nil)
Alias for: new
post_form(url, params)

Posts HTML form data to the specified URI object. The form data must be provided as a Hash mapping from String to String. Example:

{ "cmd" => "search", "q" => "ruby", "max" => "50" }

This method also does Basic Authentication iff url.user exists. But userinfo for authentication is deprecated (RFC3986). So this feature will be removed.

Example:

require 'net/http'
require 'uri'

HTTP.post_form URI('http://www.example.com/search.cgi'),
               { "q" => "ruby", "max" => "50" }
# File ../ruby/lib/net/http.rb, line 478
def HTTP.post_form(url, params)
  req = Post.new(url.request_uri)
  req.form_data = params
  req.basic_auth url.user, url.password if url.user
  new(url.hostname, url.port).start {|http|
    http.request(req)
  }
end
HTTP.start(address, port, p_addr, p_port, p_user, p_pass, &block) HTTP.start(address, port=nil, p_addr=nil, p_port=nil, p_user=nil, p_pass=nil, opt, &block)

Creates a new Net::HTTP object, then additionally opens the TCP connection and HTTP session.

Arguments are the following:

address

hostname or IP address of the server

port

port of the server

p_addr

address of proxy

p_port

port of proxy

p_user

user of proxy

p_pass

pass of proxy

opt

optional hash

opt sets following values by its accessor. The keys are #ca_file, #ca_path, cert, #cert_store, ciphers, #close_on_empty_response, key, #open_timeout, #read_timeout, #ssl_timeout, #ssl_version, use_ssl, #verify_callback, #verify_depth and verify_mode. If you set :use_ssl as true, you can use https and default value of #verify_mode is set as OpenSSL::SSL::VERIFY_PEER.

If the optional block is given, the newly created Net::HTTP object is passed to it and closed when the block finishes. In this case, the return value of this method is the return value of the block. If no block is given, the return value of this method is the newly created Net::HTTP object itself, and the caller is responsible for closing it upon completion using the finish() method.

# File ../ruby/lib/net/http.rb, line 540
def HTTP.start(address, *arg, &block) # :yield: +http+
  arg.pop if opt = Hash.try_convert(arg[-1])
  port, p_addr, p_port, p_user, p_pass = *arg
  port = https_default_port if !port && opt && opt[:use_ssl]
  http = new(address, port, p_addr, p_port, p_user, p_pass)

  if opt
    if opt[:use_ssl]
      opt = {verify_mode: OpenSSL::SSL::VERIFY_PEER}.update(opt)
    end
    http.methods.grep(/\A(\w+)=\z/) do |meth|
      key = $1.to_sym
      opt.key?(key) or next
      http.__send__(meth, opt[key])
    end
  end

  http.start(&block)
end
version_1_2()

Turns on net/http 1.2 (ruby 1.8) features. Defaults to ON in ruby 1.8 or later.

# File ../ruby/lib/net/http.rb, line 377
def HTTP.version_1_2
  true
end
version_1_2?()

Returns true if net/http is in version 1.2 mode. Defaults to true.

Also aliased as: is_version_1_2?
# File ../ruby/lib/net/http.rb, line 383
def HTTP.version_1_2?
  true
end
Instance Public methods
active?()
Alias for: started?
continue_timeout=(sec)

Setter for the #continue_timeout attribute.

# File ../ruby/lib/net/http.rb, line 647
def continue_timeout=(sec)
  @socket.continue_timeout = sec if @socket
  @continue_timeout = sec
end
copy(path, initheader = nil)

Sends a COPY request to the path and gets a response, as an HTTPResponse object.

# File ../ruby/lib/net/http.rb, line 1154
def copy(path, initheader = nil)
  request(Copy.new(path, initheader))
end
delete(path, initheader = {'Depth' => 'Infinity'})

Sends a DELETE request to the path and gets a response, as an HTTPResponse object.

# File ../ruby/lib/net/http.rb, line 1142
def delete(path, initheader = {'Depth' => 'Infinity'})
  request(Delete.new(path, initheader))
end
finish()

Finishes the HTTP session and closes the TCP connection. Raises IOError if the session has not been started.

# File ../ruby/lib/net/http.rb, line 820
def finish
  raise IOError, 'HTTP session not yet started' unless started?
  do_finish
end
get(path, initheader = {}, dest = nil)

Gets data from path on the connected-to host. initheader must be a Hash like { 'Accept' => '/', … }, and it defaults to an empty hash. If initheader doesn't have the key 'accept-encoding', then a value of “gzip;q=1.0,deflate;q=0.6,identity;q=0.3” is used, so that gzip compression is used in preference to deflate compression, which is used in preference to no compression. Ruby doesn't have libraries to support the compress (Lempel-Ziv) compression, so that is not supported. The intent of this is to reduce bandwidth by default. If this routine sets up compression, then it does the decompression also, removing the header as well to prevent confusion. Otherwise it leaves the body as it found it.

This method returns a Net::HTTPResponse object.

If called with a block, yields each fragment of the entity body in turn as a string as it is read from the socket. Note that in this case, the returned response object will not contain a (meaningful) body.

dest argument is obsolete. It still works but you must not use it.

This method never raises an exception.

response = http.get('/index.html')

# using block
File.open('result.txt', 'w') {|f|
  http.get('/~foo/') do |str|
    f.write str
  end
}
# File ../ruby/lib/net/http.rb, line 1017
def get(path, initheader = {}, dest = nil, &block) # :yield: +body_segment+
  res = nil
  if HAVE_ZLIB
    unless  initheader.keys.any?{|k| k.downcase == "accept-encoding"}
      initheader = initheader.merge({
        "accept-encoding" => "gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
      })
      @compression = true
    end
  end
  request(Get.new(path, initheader)) {|r|
    if r.key?("content-encoding") and @compression
      @compression = nil # Clear it till next set.
      the_body = r.read_body dest, &block
      case r["content-encoding"]
      when "gzip"
        r.body= Zlib::GzipReader.new(StringIO.new(the_body), encoding: "ASCII-8BIT").read
        r.delete("content-encoding")
      when "deflate"
        r.body= Zlib::Inflate.inflate(the_body);
        r.delete("content-encoding")
      when "identity"
        ; # nothing needed
      else
        ; # Don't do anything dramatic, unless we need to later
      end
    else
      r.read_body dest, &block
    end
    res = r
  }
  res
end
get2(path, initheader = nil)
Alias for: request_get
head(path, initheader = nil)

Gets only the header from path on the connected-to host. header is a Hash like { 'Accept' => '/', … }.

This method returns a Net::HTTPResponse object.

This method never raises an exception.

response = nil
Net::HTTP.start('some.www.server', 80) {|http|
  response = http.head('/index.html')
}
p response['content-type']
# File ../ruby/lib/net/http.rb, line 1064
def head(path, initheader = nil)
  request(Head.new(path, initheader))
end
head2(path, initheader = nil, &block)
Alias for: request_head
inspect()
# File ../ruby/lib/net/http.rb, line 599
def inspect
  "#<#{self.class} #{@address}:#{@port} open=#{started?}>"
end
lock(path, body, initheader = nil)

Sends a LOCK request to the path and gets a response, as an HTTPResponse object.

# File ../ruby/lib/net/http.rb, line 1118
def lock(path, body, initheader = nil)
  request(Lock.new(path, initheader), body)
end
mkcol(path, body = nil, initheader = nil)

Sends a MKCOL request to the path and gets a response, as an HTTPResponse object.

# File ../ruby/lib/net/http.rb, line 1160
def mkcol(path, body = nil, initheader = nil)
  request(Mkcol.new(path, initheader), body)
end
move(path, initheader = nil)

Sends a MOVE request to the path and gets a response, as an HTTPResponse object.

# File ../ruby/lib/net/http.rb, line 1148
def move(path, initheader = nil)
  request(Move.new(path, initheader))
end
options(path, initheader = nil)

Sends a OPTIONS request to the path and gets a response, as an HTTPResponse object.

# File ../ruby/lib/net/http.rb, line 1130
def options(path, initheader = nil)
  request(Options.new(path, initheader))
end
patch(path, data, initheader = nil, dest = nil)

Sends a PATCH request to the path and gets a response, as an HTTPResponse object.

# File ../ruby/lib/net/http.rb, line 1102
def patch(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
  send_entity(path, data, initheader, dest, Patch, &block)
end
peer_cert()

Returns the X.509 certificates the server presented.

# File ../ruby/lib/net/http.rb, line 725
def peer_cert
  if not use_ssl? or not @socket
    return nil
  end
  @socket.io.peer_cert
end
post(path, data, initheader = nil, dest = nil)

Posts data (must be a String) to path. header must be a Hash like { 'Accept' => '/', … }.

This method returns a Net::HTTPResponse object.

If called with a block, yields each fragment of the entity body in turn as a string as it is read from the socket. Note that in this case, the returned response object will not contain a (meaningful) body.

dest argument is obsolete. It still works but you must not use it.

This method never raises exception.

response = http.post('/cgi-bin/search.rb', 'query=foo')

# using block
File.open('result.txt', 'w') {|f|
  http.post('/cgi-bin/search.rb', 'query=foo') do |str|
    f.write str
  end
}

You should set Content-Type: header field for POST. If no Content-Type: field given, this method uses “application/x-www-form-urlencoded” by default.

# File ../ruby/lib/net/http.rb, line 1096
def post(path, data, initheader = nil, dest = nil, &block) # :yield: +body_segment+
  send_entity(path, data, initheader, dest, Post, &block)
end
post2(path, data, initheader = nil)
Alias for: request_post
propfind(path, body = nil, initheader = {'Depth' => '0'})

Sends a PROPFIND request to the path and gets a response, as an HTTPResponse object.

# File ../ruby/lib/net/http.rb, line 1136
def propfind(path, body = nil, initheader = {'Depth' => '0'})
  request(Propfind.new(path, initheader), body)
end
proppatch(path, body, initheader = nil)

Sends a PROPPATCH request to the path and gets a response, as an HTTPResponse object.

# File ../ruby/lib/net/http.rb, line 1112
def proppatch(path, body, initheader = nil)
  request(Proppatch.new(path, initheader), body)
end
proxy?()

True if self is a HTTP proxy class.

# File ../ruby/lib/net/http.rb, line 917
def proxy?
  self.class.proxy_class?
end
proxy_address()

A convenience method for accessing value of #proxy_address from Net::HTTP.

Also aliased as: proxyaddr
# File ../ruby/lib/net/http.rb, line 922
def proxy_address
  self.class.proxy_address
end
proxy_class?()

returns true if self is a class which was created by HTTP::Proxy.

# File ../ruby/lib/net/http.rb, line 898
def proxy_class?
  @is_proxy_class
end
proxy_pass()

A convenience method for accessing value of #proxy_pass from Net::HTTP.

# File ../ruby/lib/net/http.rb, line 937
def proxy_pass
  self.class.proxy_pass
end
proxy_port()

A convenience method for accessing value of #proxy_port from Net::HTTP.

Also aliased as: proxyport
# File ../ruby/lib/net/http.rb, line 927
def proxy_port
  self.class.proxy_port
end
proxy_user()

A convenience method for accessing value of #proxy_user from Net::HTTP.

# File ../ruby/lib/net/http.rb, line 932
def proxy_user
  self.class.proxy_user
end
proxyaddr()
Alias for: proxy_address
proxyport()
Alias for: proxy_port
read_timeout=(sec)

Setter for the #read_timeout attribute.

# File ../ruby/lib/net/http.rb, line 636
def read_timeout=(sec)
  @socket.read_timeout = sec if @socket
  @read_timeout = sec
end
request(req, body = nil)

Sends an HTTPRequest object req to the HTTP server.

If req is a Net::HTTP::Post or Net::HTTP::Put request containing data, the data is also sent. Providing data for a Net::HTTP::Head or Net::HTTP::Get request results in an ArgumentError.

Returns an HTTPResponse object.

When called with a block, passes an HTTPResponse object to the block. The body of the response will not have been read yet; the block can process it using Net::HTTPResponse#read_body, if desired.

This method never raises Net::* exceptions.

# File ../ruby/lib/net/http.rb, line 1283
def request(req, body = nil, &block)  # :yield: +response+
  unless started?
    start {
      req['connection'] ||= 'close'
      return request(req, body, &block)
    }
  end
  if proxy_user()
    req.proxy_basic_auth proxy_user(), proxy_pass() unless use_ssl?
  end
  req.set_body_internal body
  res = transport_request(req, &block)
  if sspi_auth?(res)
    sspi_auth(req)
    res = transport_request(req, &block)
  end
  res
end
request_get(path, initheader = nil)

Sends a GET request to the path. Returns the response as a Net::HTTPResponse object.

When called with a block, passes an HTTPResponse object to the block. The body of the response will not have been read yet; the block can process it using Net::HTTPResponse#read_body, if desired.

Returns the response.

This method never raises Net::* exceptions.

response = http.request_get('/index.html')
# The entity body is already read in this case.
p response['content-type']
puts response.body

# Using a block
http.request_get('/index.html') {|response|
  p response['content-type']
  response.read_body do |str|   # read body now
    print str
  end
}
Also aliased as: get2
# File ../ruby/lib/net/http.rb, line 1195
def request_get(path, initheader = nil, &block) # :yield: +response+
  request(Get.new(path, initheader), &block)
end
request_head(path, initheader = nil, &block)

Sends a HEAD request to the path and returns the response as a Net::HTTPResponse object.

Returns the response.

This method never raises Net::* exceptions.

response = http.request_head('/index.html')
p response['content-type']
Also aliased as: head2
# File ../ruby/lib/net/http.rb, line 1209
def request_head(path, initheader = nil, &block)
  request(Head.new(path, initheader), &block)
end
request_post(path, data, initheader = nil)

Sends a POST request to the path.

Returns the response as a Net::HTTPResponse object.

When called with a block, the block is passed an HTTPResponse object. The body of that response will not have been read yet; the block can process it using Net::HTTPResponse#read_body, if desired.

Returns the response.

This method never raises Net::* exceptions.

# example
response = http.request_post('/cgi-bin/nice.rb', 'datadatadata...')
p response.status
puts response.body          # body is already read in this case

# using block
http.request_post('/cgi-bin/nice.rb', 'datadatadata...') {|response|
  p response.status
  p response['content-type']
  response.read_body do |str|   # read body now
    print str
  end
}
Also aliased as: post2
# File ../ruby/lib/net/http.rb, line 1239
def request_post(path, data, initheader = nil, &block) # :yield: +response+
  request Post.new(path, initheader), data, &block
end
send_request(name, path, data = nil, header = nil)

Sends an HTTP request to the HTTP server. Also sends a DATA string if data is given.

Returns a Net::HTTPResponse object.

This method never raises Net::* exceptions.

response = http.send_request('GET', '/index.html')
puts response.body
# File ../ruby/lib/net/http.rb, line 1263
def send_request(name, path, data = nil, header = nil)
  r = HTTPGenericRequest.new(name,(data ? true : false),true,path,header)
  request r, data
end
set_debug_output(output)

WARNING This method opens a serious security hole. Never use this method in production code.

Sets an output stream for debugging.

http = Net::HTTP.new
http.set_debug_output $stderr
http.start { .... }
# File ../ruby/lib/net/http.rb, line 612
def set_debug_output(output)
  warn 'Net::HTTP#set_debug_output called after HTTP started' if started?
  @debug_output = output
end
start()

Opens a TCP connection and HTTP session.

When this method is called with a block, it passes the Net::HTTP object to the block, and closes the TCP connection and HTTP session after the block has been executed.

When called with a block, it returns the return value of the block; otherwise, it returns self.

# File ../ruby/lib/net/http.rb, line 741
def start  # :yield: http
  raise IOError, 'HTTP session already opened' if @started
  if block_given?
    begin
      do_start
      return yield(self)
    ensure
      do_finish
    end
  end
  do_start
  self
end
started?()

Returns true if the HTTP session has been started.

Also aliased as: active?
# File ../ruby/lib/net/http.rb, line 653
def started?
  @started
end
trace(path, initheader = nil)

Sends a TRACE request to the path and gets a response, as an HTTPResponse object.

# File ../ruby/lib/net/http.rb, line 1166
def trace(path, initheader = nil)
  request(Trace.new(path, initheader))
end
unlock(path, body, initheader = nil)

Sends a UNLOCK request to the path and gets a response, as an HTTPResponse object.

# File ../ruby/lib/net/http.rb, line 1124
def unlock(path, body, initheader = nil)
  request(Unlock.new(path, initheader), body)
end
use_ssl=(flag)

Turn on/off SSL. This flag must be set before starting session. If you change use_ssl value after session started, a Net::HTTP object raises IOError.

# File ../ruby/lib/net/http.rb, line 670
def use_ssl=(flag)
  flag = flag ? true : false
  if started? and @use_ssl != flag
    raise IOError, "use_ssl value changed, but session already started"
  end
  @use_ssl = flag
end
use_ssl?()

Returns true if SSL/TLS is being used with HTTP.

# File ../ruby/lib/net/http.rb, line 662
def use_ssl?
  @use_ssl
end
Instance Private methods
D(msg)
# File ../ruby/lib/net/http.rb, line 1409
def D(msg)
  return unless @debug_output
  @debug_output << msg
  @debug_output << "\n"
end
addr_port()

utils

# File ../ruby/lib/net/http.rb, line 1401
def addr_port
  if use_ssl?
    address() + (port == HTTP.https_default_port ? '' : ":#{port()}")
  else
    address() + (port == HTTP.http_default_port ? '' : ":#{port()}")
  end
end
begin_transport(req)
# File ../ruby/lib/net/http.rb, line 1335
def begin_transport(req)
  connect if @socket.closed?
  if not req.response_body_permitted? and @close_on_empty_response
    req['connection'] ||= 'close'
  end
  req['host'] ||= addr_port()
end
conn_address()

without proxy

# File ../ruby/lib/net/http.rb, line 948
def conn_address
  address()
end
conn_port()
# File ../ruby/lib/net/http.rb, line 952
def conn_port
  port()
end
connect()
# File ../ruby/lib/net/http.rb, line 761
def connect
  D "opening connection to #{conn_address()}..."
  s = timeout(@open_timeout) { TCPSocket.open(conn_address(), conn_port()) }
  D "opened"
  if use_ssl?
    ssl_parameters = Hash.new
    iv_list = instance_variables
    SSL_ATTRIBUTES.each do |name|
      ivname = "@#{name}".intern
      if iv_list.include?(ivname) and
         value = instance_variable_get(ivname)
        ssl_parameters[name] = value
      end
    end
    @ssl_context = OpenSSL::SSL::SSLContext.new
    @ssl_context.set_params(ssl_parameters)
    s = OpenSSL::SSL::SSLSocket.new(s, @ssl_context)
    s.sync_close = true
  end
  @socket = BufferedIO.new(s)
  @socket.read_timeout = @read_timeout
  @socket.continue_timeout = @continue_timeout
  @socket.debug_output = @debug_output
  if use_ssl?
    begin
      if proxy?
        @socket.writeline sprintf('CONNECT %s:%s HTTP/%s',
                                  @address, @port, HTTPVersion)
        @socket.writeline "Host: #{@address}:#{@port}"
        if proxy_user
          credential = ["#{proxy_user}:#{proxy_pass}"].pack('m')
          credential.delete!("\r\n")
          @socket.writeline "Proxy-Authorization: Basic #{credential}"
        end
        @socket.writeline ''
        HTTPResponse.read_new(@socket).value
      end
      # Server Name Indication (SNI) RFC 3546
      s.hostname = @address if s.respond_to? :hostname=
      timeout(@open_timeout) { s.connect }
      if @ssl_context.verify_mode != OpenSSL::SSL::VERIFY_NONE
        s.post_connection_check(@address)
      end
    rescue => exception
      D "Conn close because of connect error #{exception}"
      @socket.close if @socket and not @socket.closed?
      raise exception
    end
  end
  on_connect
end
do_finish()
# File ../ruby/lib/net/http.rb, line 825
def do_finish
  @started = false
  @socket.close if @socket and not @socket.closed?
  @socket = nil
end
do_start()
# File ../ruby/lib/net/http.rb, line 755
def do_start
  connect
  @started = true
end
edit_path(path)
# File ../ruby/lib/net/http.rb, line 956
def edit_path(path)
  path
end
end_transport(req, res)
# File ../ruby/lib/net/http.rb, line 1343
def end_transport(req, res)
  @curr_http_version = res.http_version
  if @socket.closed?
    D 'Conn socket closed'
  elsif not res.body and @close_on_empty_response
    D 'Conn close'
    @socket.close
  elsif keep_alive?(req, res)
    D 'Conn keep-alive'
  else
    D 'Conn close'
    @socket.close
  end
end
keep_alive?(req, res)
# File ../ruby/lib/net/http.rb, line 1358
def keep_alive?(req, res)
  return false if req.connection_close?
  if @curr_http_version <= '1.0'
    res.connection_keep_alive?
  else   # HTTP/1.1 or later
    not res.connection_close?
  end
end
on_connect()
# File ../ruby/lib/net/http.rb, line 814
def on_connect
end
send_entity(path, data, initheader, dest, type, &block)

Executes a request which uses a representation and returns its body.

# File ../ruby/lib/net/http.rb, line 1306
def send_entity(path, data, initheader, dest, type, &block)
  res = nil
  request(type.new(path, initheader), data) {|r|
    r.read_body dest, &block
    res = r
  }
  res
end
sspi_auth(req)
# File ../ruby/lib/net/http.rb, line 1382
def sspi_auth(req)
  n = Win32::SSPI::NegotiateAuth.new
  req["Proxy-Authorization"] = "Negotiate #{n.get_initial_token}"
  # Some versions of ISA will close the connection if this isn't present.
  req["Connection"] = "Keep-Alive"
  req["Proxy-Connection"] = "Keep-Alive"
  res = transport_request(req)
  authphrase = res["Proxy-Authenticate"]  or return res
  req["Proxy-Authorization"] = "Negotiate #{n.complete_authentication(authphrase)}"
rescue => err
  raise HTTPAuthenticationError.new('HTTP authentication failed', err)
end
sspi_auth?(res)
# File ../ruby/lib/net/http.rb, line 1367
def sspi_auth?(res)
  return false unless @sspi_enabled
  if res.kind_of?(HTTPProxyAuthenticationRequired) and
      proxy? and res["Proxy-Authenticate"].include?("Negotiate")
    begin
      require 'win32/sspi'
      true
    rescue LoadError
      false
    end
  else
    false
  end
end
transport_request(req)
# File ../ruby/lib/net/http.rb, line 1315
def transport_request(req)
  begin_transport req
  res = catch(:response) {
    req.exec @socket, @curr_http_version, edit_path(req.path)
    begin
      res = HTTPResponse.read_new(@socket)
    end while res.kind_of?(HTTPContinue)
    res.reading_body(@socket, req.response_body_permitted?) {
      yield res if block_given?
    }
    res
  }
  end_transport req, res
  res
rescue => exception
  D "Conn close because of error #{exception}"
  @socket.close if @socket and not @socket.closed?
  raise exception
end