Class: Puma::Client

Inherits:
Object
  • Object
show all
Includes:
Const
Defined in:
lib/puma/client.rb

Constant Summary collapse

EmptyBody =

The object used for a request with no body. All requests with no body share this one object since it has no state.

NullIO.new

Constants included from Const

Puma::Const::CGI_VER, Puma::Const::CHUNK_SIZE, Puma::Const::CLOSE, Puma::Const::CLOSE_CHUNKED, Puma::Const::CODE_NAME, Puma::Const::COLON, Puma::Const::CONNECTION_CLOSE, Puma::Const::CONNECTION_KEEP_ALIVE, Puma::Const::CONTENT_LENGTH, Puma::Const::CONTENT_LENGTH2, Puma::Const::CONTENT_LENGTH_S, Puma::Const::CONTENT_TYPE, Puma::Const::DATE, Puma::Const::ERROR_400_RESPONSE, Puma::Const::ERROR_404_RESPONSE, Puma::Const::ERROR_500_RESPONSE, Puma::Const::ERROR_503_RESPONSE, Puma::Const::ETAG, Puma::Const::ETAG_FORMAT, Puma::Const::FAST_TRACK_KA_TIMEOUT, Puma::Const::FIRST_DATA_TIMEOUT, Puma::Const::GATEWAY_INTERFACE, Puma::Const::GET, Puma::Const::HALT_COMMAND, Puma::Const::HEAD, Puma::Const::HIJACK, Puma::Const::HIJACK_IO, Puma::Const::HIJACK_P, Puma::Const::HOST, Puma::Const::HTTP, Puma::Const::HTTPS, Puma::Const::HTTPS_KEY, Puma::Const::HTTP_10, Puma::Const::HTTP_10_200, Puma::Const::HTTP_11, Puma::Const::HTTP_11_200, Puma::Const::HTTP_CONNECTION, Puma::Const::HTTP_HOST, Puma::Const::HTTP_IF_MODIFIED_SINCE, Puma::Const::HTTP_IF_NONE_MATCH, Puma::Const::HTTP_VERSION, Puma::Const::HTTP_X_FORWARDED_FOR, Puma::Const::KEEP_ALIVE, Puma::Const::LAST_MODIFIED, Puma::Const::LINE_END, Puma::Const::LOCALHOST, Puma::Const::MAX_BODY, Puma::Const::MAX_HEADER, Puma::Const::NEWLINE, Puma::Const::PATH_INFO, Puma::Const::PERSISTENT_TIMEOUT, Puma::Const::PORT_443, Puma::Const::PORT_80, Puma::Const::PUMA_CONFIG, Puma::Const::PUMA_SOCKET, Puma::Const::PUMA_TMP_BASE, Puma::Const::PUMA_VERSION, Puma::Const::RACK_AFTER_REPLY, Puma::Const::RACK_INPUT, Puma::Const::RACK_URL_SCHEME, Puma::Const::REDIRECT, Puma::Const::REMOTE_ADDR, Puma::Const::REQUEST_METHOD, Puma::Const::REQUEST_PATH, Puma::Const::REQUEST_URI, Puma::Const::RESTART_COMMAND, Puma::Const::SCRIPT_NAME, Puma::Const::SERVER_NAME, Puma::Const::SERVER_PORT, Puma::Const::SERVER_PROTOCOL, Puma::Const::SERVER_SOFTWARE, Puma::Const::SLASH, Puma::Const::STATUS_FORMAT, Puma::Const::STOP_COMMAND, Puma::Const::TRANSFER_ENCODING, Puma::Const::TRANSFER_ENCODING_CHUNKED

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(io, env) ⇒ Client

Returns a new instance of Client.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/puma/client.rb', line 25

def initialize(io, env)
  @io = io
  @to_io = io.to_io
  @proto_env = env
  @env = env.dup

  @parser = HttpParser.new
  @parsed_bytes = 0
  @read_header = true
  @ready = false

  @body = nil
  @buffer = nil

  @timeout_at = nil

  @requests_served = 0
  @hijacked = false
end

Instance Attribute Details

#body ⇒ Object (readonly)

Returns the value of attribute body.



45
46
47
 
# File 'lib/puma/client.rb', line 45

def body
  @body
end

#env ⇒ Object (readonly)

Returns the value of attribute env.



45
46
47
 
# File 'lib/puma/client.rb', line 45

def env
  @env
end

#hijacked ⇒ Object (readonly)

Returns the value of attribute hijacked.



45
46
47
 
# File 'lib/puma/client.rb', line 45

def hijacked
  @hijacked
end

#io ⇒ Object (readonly)

Returns the value of attribute io.



45
46
47
 
# File 'lib/puma/client.rb', line 45

def io
  @io
end

#ready ⇒ Object (readonly)

Returns the value of attribute ready.



45
46
47
 
# File 'lib/puma/client.rb', line 45

def ready
  @ready
end

#timeout_at ⇒ Object (readonly)

Returns the value of attribute timeout_at.



45
46
47
 
# File 'lib/puma/client.rb', line 45

def timeout_at
  @timeout_at
end

#to_io ⇒ Object (readonly)

Returns the value of attribute to_io.



45
46
47
 
# File 'lib/puma/client.rb', line 45

def to_io
  @to_io
end

Instance Method Details

#call ⇒ Object

For the hijack protocol (allows us to just put the Client object into the env)



53
54
55
56
 
# File 'lib/puma/client.rb', line 53

def call
  @hijacked = true
  env[HIJACK_IO] ||= @io
end

#close ⇒ Object 



87
88
89
90
91
92
 
# File 'lib/puma/client.rb', line 87

def close
  begin
    @io.close
  rescue IOError
  end
end

#eagerly_finish ⇒ Object 



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/puma/client.rb', line 196

def eagerly_finish
  return true if @ready

  if @io.kind_of? OpenSSL::SSL::SSLSocket
    return true if jruby_start_try_to_finish
  end

  return false unless IO.select([@to_io], nil, nil, 0)
  try_to_finish
end

#inspect ⇒ Object 



47
48
49
 
# File 'lib/puma/client.rb', line 47

def inspect
  "#<Puma::Client:0x#{object_id.to_s(16)} @ready=#{@ready.inspect}>"
end

#jruby_start_try_to_finish ⇒ Object 



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/puma/client.rb', line 168

def jruby_start_try_to_finish
  return read_body unless @read_header

  begin
    data = @io.sysread_nonblock(CHUNK_SIZE)
  rescue OpenSSL::SSL::SSLError => e
    return false if e.kind_of? IO::WaitReadable
    raise e
  end

  if @buffer
    @buffer << data
  else
    @buffer = data
  end

  @parsed_bytes = @parser.execute(@env, @buffer, @parsed_bytes)

  if @parser.finished?
    return setup_body
  elsif @parsed_bytes >= MAX_HEADER
    raise HttpParserError,
      "HEADER is longer than allowed, aborting client early."
  end

  false
end

#read_body ⇒ Object

IS_JRUBY



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/puma/client.rb', line 216

def read_body
  # Read an odd sized chunk so we can read even sized ones
  # after this
  remain = @body_remain

  if remain > CHUNK_SIZE
    want = CHUNK_SIZE
  else
    want = remain
  end

  begin
    chunk = @io.read_nonblock(want)
  rescue Errno::EAGAIN
    return false
  rescue SystemCallError, IOError
    raise ConnectionError, "Connection error detected during read"
  end

  # No chunk means a closed socket
  unless chunk
    @body.close
    @buffer = nil
    @requests_served += 1
    @ready = true
    raise EOFError
  end

  remain -= @body.write(chunk)

  if remain <= 0
    @body.rewind
    @buffer = nil
    @requests_served += 1
    @ready = true
    return true
  end

  @body_remain = remain

  false
end

#reset(fast_check = true) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/puma/client.rb', line 62

def reset(fast_check=true)
  @parser.reset
  @read_header = true
  @env = @proto_env.dup
  @body = nil
  @parsed_bytes = 0
  @ready = false

  if @buffer
    @parsed_bytes = @parser.execute(@env, @buffer, @parsed_bytes)

    if @parser.finished?
      return setup_body
    elsif @parsed_bytes >= MAX_HEADER
      raise HttpParserError,
        "HEADER is longer than allowed, aborting client early."
    end

    return false
  elsif fast_check &&
        IO.select([@to_io], nil, nil, FAST_TRACK_KA_TIMEOUT)
    return try_to_finish
  end
end

#set_timeout(val) ⇒ Object 



58
59
60
 
# File 'lib/puma/client.rb', line 58

def set_timeout(val)
  @timeout_at = Time.now + val
end

#setup_body ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/puma/client.rb', line 98

def setup_body
  body = @parser.body
  cl = @env[CONTENT_LENGTH]

  unless cl
    @buffer = body.empty? ? nil : body
    @body = EmptyBody
    @requests_served += 1
    @ready = true
    return true
  end

  remain = cl.to_i - body.bytesize

  if remain <= 0
    @body = StringIO.new(body)
    @buffer = nil
    @requests_served += 1
    @ready = true
    return true
  end

  if remain > MAX_BODY
    @body = Tempfile.new(Const::PUMA_TMP_BASE)
    @body.binmode
  else
    # The body[0,0] trick is to get an empty string in the same
    # encoding as body.
    @body = StringIO.new body[0,0]
  end

  @body.write body

  @body_remain = remain

  @read_header = false

  return false
end

#try_to_finish ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/puma/client.rb', line 138

def try_to_finish
  return read_body unless @read_header

  begin
    data = @io.read_nonblock(CHUNK_SIZE)
  rescue Errno::EAGAIN
    return false
  rescue SystemCallError, IOError
    raise ConnectionError, "Connection error detected during read"
  end

  if @buffer
    @buffer << data
  else
    @buffer = data
  end

  @parsed_bytes = @parser.execute(@env, @buffer, @parsed_bytes)

  if @parser.finished?
    return setup_body
  elsif @parsed_bytes >= MAX_HEADER
    raise HttpParserError,
      "HEADER is longer than allowed, aborting client early."
  end
  
  false
end

#write_400 ⇒ Object 



259
260
261
262
263
264
 
# File 'lib/puma/client.rb', line 259

def write_400
  begin
    @io << ERROR_400_RESPONSE
  rescue StandardError
  end
end

#write_500 ⇒ Object 



266
267
268
269
270
271
 
# File 'lib/puma/client.rb', line 266

def write_500
  begin
    @io << ERROR_500_RESPONSE
  rescue StandardError
  end
end