Module: Puma::Const

Included in:
Binder, Client, ErrorLogger, Server
Defined in:
lib/puma/const.rb

Overview

Frequently used constants when constructing requests or responses. Many times the constant just refers to a string with the same contents. Using these constants gave about a 3% to 10% performance improvement over using the strings directly.

The constants are frozen because Hash#[]= when called with a String key dups the String UNLESS the String is frozen. This saves us therefore 2 object allocations when creating the env hash later.

While Puma does try to emulate the CGI/1.2 protocol, it does not use the REMOTE_IDENT, REMOTE_USER, or REMOTE_HOST parameters since those are either a security problem or too taxing on performance.

Constant Summary collapse

PUMA_VERSION =
VERSION = "5.0.0.beta2".freeze
CODE_NAME =
"Spoony Bard".freeze
PUMA_SERVER_STRING =
['puma', PUMA_VERSION, CODE_NAME].join(' ').freeze
FAST_TRACK_KA_TIMEOUT =
0.2
PERSISTENT_TIMEOUT =

The default number of seconds for another request within a persistent session.

20
FIRST_DATA_TIMEOUT =

The default number of seconds to wait until we get the first data for the request

30
WRITE_TIMEOUT =

How long to wait when getting some write blocking on the socket when sending data back

10
MAX_FAST_INLINE =

How many requests to attempt inline before sending a client back to the reactor to be subject to normal ordering. The idea here is that we amortize the cost of going back to the reactor for a well behaved but very “greedy” client across 10 requests. This prevents a not well behaved client from monopolizing the thread forever.

10
REQUEST_URI =

The original URI requested by the client.

'REQUEST_URI'.freeze
REQUEST_PATH =
'REQUEST_PATH'.freeze
QUERY_STRING =
'QUERY_STRING'.freeze
CONTENT_LENGTH =
"CONTENT_LENGTH".freeze
PATH_INFO =
'PATH_INFO'.freeze
PUMA_TMP_BASE =
"puma".freeze
ERROR_RESPONSE =
{
  # Indicate that we couldn't parse the request
  400 => "HTTP/1.1 400 Bad Request\r\n\r\n".freeze,
  # The standard empty 404 response for bad requests.  Use Error4040Handler for custom stuff.
  404 => "HTTP/1.1 404 Not Found\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\nNOT FOUND".freeze,
  # The standard empty 408 response for requests that timed out.
  408 => "HTTP/1.1 408 Request Timeout\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\n".freeze,
  # Indicate that there was an internal error, obviously.
  500 => "HTTP/1.1 500 Internal Server Error\r\n\r\n".freeze,
  # A common header for indicating the server is too busy.  Not used yet.
  503 => "HTTP/1.1 503 Service Unavailable\r\n\r\nBUSY".freeze
}
CHUNK_SIZE =

The basic max request size we'll try to read.

16 * 1024
MAX_HEADER =

This is the maximum header that is allowed before a client is booted. The parser detects this, but we'd also like to do this as well.

1024 * (80 + 32)
MAX_BODY =

Maximum request body size before it is moved out of memory and into a tempfile for reading.

MAX_HEADER
REQUEST_METHOD =
"REQUEST_METHOD".freeze
HEAD =
"HEAD".freeze
LINE_END =

ETag is based on the apache standard of hex mtime-size-inode (inode is 0 on win32)

"\r\n".freeze
REMOTE_ADDR =
"REMOTE_ADDR".freeze
HTTP_X_FORWARDED_FOR =
"HTTP_X_FORWARDED_FOR".freeze
HTTP_X_FORWARDED_SSL =
"HTTP_X_FORWARDED_SSL".freeze
HTTP_X_FORWARDED_SCHEME =
"HTTP_X_FORWARDED_SCHEME".freeze
HTTP_X_FORWARDED_PROTO =
"HTTP_X_FORWARDED_PROTO".freeze
SERVER_NAME =
"SERVER_NAME".freeze
SERVER_PORT =
"SERVER_PORT".freeze
HTTP_HOST =
"HTTP_HOST".freeze
PORT_80 =
"80".freeze
PORT_443 =
"443".freeze
LOCALHOST =
"localhost".freeze
LOCALHOST_IP =
"127.0.0.1".freeze
SERVER_PROTOCOL =
"SERVER_PROTOCOL".freeze
HTTP_11 =
"HTTP/1.1".freeze
SERVER_SOFTWARE =
"SERVER_SOFTWARE".freeze
GATEWAY_INTERFACE =
"GATEWAY_INTERFACE".freeze
CGI_VER =
"CGI/1.2".freeze
STOP_COMMAND =
"?".freeze
HALT_COMMAND =
"!".freeze
RESTART_COMMAND =
"R".freeze
RACK_INPUT =
"rack.input".freeze
RACK_URL_SCHEME =
"rack.url_scheme".freeze
RACK_AFTER_REPLY =
"rack.after_reply".freeze
PUMA_SOCKET =
"puma.socket".freeze
PUMA_CONFIG =
"puma.config".freeze
PUMA_PEERCERT =
"puma.peercert".freeze
HTTP =
"http".freeze
HTTPS =
"https".freeze
HTTPS_KEY =
"HTTPS".freeze
HTTP_VERSION =
"HTTP_VERSION".freeze
HTTP_CONNECTION =
"HTTP_CONNECTION".freeze
HTTP_EXPECT =
"HTTP_EXPECT".freeze
CONTINUE =
"100-continue".freeze
HTTP_11_100 =
"HTTP/1.1 100 Continue\r\n\r\n".freeze
HTTP_11_200 =
"HTTP/1.1 200 OK\r\n".freeze
HTTP_10_200 =
"HTTP/1.0 200 OK\r\n".freeze
CLOSE =
"close".freeze
KEEP_ALIVE =
"keep-alive".freeze
CONTENT_LENGTH2 =
"content-length".freeze
CONTENT_LENGTH_S =
"Content-Length: ".freeze
TRANSFER_ENCODING =
"transfer-encoding".freeze
TRANSFER_ENCODING2 =
"HTTP_TRANSFER_ENCODING".freeze
CONNECTION_CLOSE =
"Connection: close\r\n".freeze
CONNECTION_KEEP_ALIVE =
"Connection: Keep-Alive\r\n".freeze
TRANSFER_ENCODING_CHUNKED =
"Transfer-Encoding: chunked\r\n".freeze
CLOSE_CHUNKED =
"0\r\n\r\n".freeze
CHUNKED =
"chunked".freeze
COLON =
": ".freeze
NEWLINE =
"\n".freeze
HTTP_INJECTION_REGEX =
/[\r\n]/.freeze
HIJACK_P =
"rack.hijack?".freeze
HIJACK =
"rack.hijack".freeze
HIJACK_IO =
"rack.hijack_io".freeze
EARLY_HINTS =
"rack.early_hints".freeze
WORKER_CHECK_INTERVAL =

Mininum interval to checks worker health

5