Class: HTTP::Connection

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/http/connection.rb

Overview

A connection to the HTTP server

Constant Summary collapse

BUFFER_SIZE =

Attempt to read this much data

16_384
HTTP_1_0 =

HTTP/1.0

"1.0".freeze
HTTP_1_1 =

HTTP/1.1

"1.1".freeze

Instance Method Summary collapse

Constructor Details

#initialize(req, options) ⇒ Connection

Returns a new instance of Connection.

Parameters:


23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# File 'lib/http/connection.rb', line 23

def initialize(req, options)
  @persistent           = options.persistent?
  @keep_alive_timeout   = options[:keep_alive_timeout].to_f
  @pending_request      = false
  @pending_response     = false
  @failed_proxy_connect = false

  @parser = Response::Parser.new

  @socket = options[:timeout_class].new(options[:timeout_options])
  @socket.connect(options[:socket_class], req.socket_host, req.socket_port)

  send_proxy_connect_request(req)
  start_tls(req, options)
  reset_timer
end

Instance Method Details

#closevoid

This method returns an undefined value.

Close the connection


124
125
126
127
128
129
# File 'lib/http/connection.rb', line 124

def close
  @socket.close unless @socket.closed?

  @pending_response = false
  @pending_request  = false
end

#expired?Boolean

Whether our connection has expired

Returns:

  • (Boolean)

139
140
141
# File 'lib/http/connection.rb', line 139

def expired?
  !@conn_expires_at || @conn_expires_at < Time.now
end

#failed_proxy_connect?Boolean

Returns whenever proxy connect failed.

Returns:

  • (Boolean)

    whenever proxy connect failed


50
51
52
# File 'lib/http/connection.rb', line 50

def failed_proxy_connect?
  @failed_proxy_connect
end

#finish_responsevoid

This method returns an undefined value.

Callback for when we've reached the end of a response


112
113
114
115
116
117
118
119
120
# File 'lib/http/connection.rb', line 112

def finish_response
  close unless keep_alive?

  @parser.reset
  @socket.reset_counter if @socket.respond_to?(:reset_counter)
  reset_timer

  @pending_response = false
end

#keep_alive?Boolean

Whether we're keeping the conn alive

Returns:

  • (Boolean)

133
134
135
# File 'lib/http/connection.rb', line 133

def keep_alive?
  !!@keep_alive && !@socket.closed?
end

#read_headers!void

This method returns an undefined value.

Reads data from socket up until headers are loaded


95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'lib/http/connection.rb', line 95

def read_headers!
  loop do
    if read_more(BUFFER_SIZE) == :eof
      fail EOFError unless @parser.headers?
      break
    else
      break if @parser.headers?
    end
  end

  set_keep_alive
rescue IOError, Errno::ECONNRESET, Errno::EPIPE => e
  raise IOError, "problem making HTTP request: #{e}"
end

#readpartial(size = BUFFER_SIZE) ⇒ String?

Read a chunk of the body

Returns:

  • (String)

    data chunk

  • (nil)

    when no more data left


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/http/connection.rb', line 77

def readpartial(size = BUFFER_SIZE)
  return unless @pending_response

  if read_more(size) == :eof
    finished = true
  else
    finished = @parser.finished?
  end

  chunk = @parser.chunk

  finish_response if finished

  chunk.to_s
end

#send_request(req) ⇒ nil

Send a request to the server

Parameters:

  • req (Request)

    Request to send to the server

Returns:

  • (nil)

58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/http/connection.rb', line 58

def send_request(req)
  if @pending_response
    fail StateError, "Tried to send a request while one is pending already. Make sure you read off the body."
  elsif @pending_request
    fail StateError, "Tried to send a request while a response is pending. Make sure you've fully read the body from the request."
  end

  @pending_request = true

  req.stream @socket

  @pending_response = true
  @pending_request  = false
end