Module: Puma::Const

Included in:
Binder, Client, Events, 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

PUMA_VERSION =
VERSION = "2.11.1".freeze
CODE_NAME =
"Intrepid Squirrel".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
DATE =
"Date".freeze
SCRIPT_NAME =
"SCRIPT_NAME".freeze
REQUEST_URI =

The original URI requested by the client.

'REQUEST_URI'.freeze
REQUEST_PATH =
'REQUEST_PATH'.freeze
PATH_INFO =
'PATH_INFO'.freeze
PUMA_TMP_BASE =
"puma".freeze
ERROR_400_RESPONSE =

Indicate that we couldn't parse the request

"HTTP/1.1 400 Bad Request\r\n\r\n".freeze
ERROR_404_RESPONSE =

The standard empty 404 response for bad requests. Use Error4040Handler for custom stuff.

"HTTP/1.1 404 Not Found\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\nNOT FOUND".freeze
ERROR_408_RESPONSE =

The standard empty 408 response for requests that timed out.

"HTTP/1.1 408 Request Timeout\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\n".freeze
CONTENT_LENGTH =
"CONTENT_LENGTH".freeze
ERROR_500_RESPONSE =

Indicate that there was an internal error, obviously.

"HTTP/1.1 500 Internal Server Error\r\n\r\n".freeze
ERROR_503_RESPONSE =

A common header for indicating the server is too busy. Not used yet.

"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
STATUS_FORMAT =

A frozen format for this is about 15% faster

"HTTP/1.1 %d %s\r\nConnection: close\r\n".freeze
CONTENT_TYPE =
"Content-Type".freeze
LAST_MODIFIED =
"Last-Modified".freeze
ETAG =
"ETag".freeze
SLASH =
"/".freeze
REQUEST_METHOD =
"REQUEST_METHOD".freeze
GET =
"GET".freeze
HEAD =
"HEAD".freeze
ETAG_FORMAT =

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

"\"%x-%x-%x\"".freeze
LINE_END =
"\r\n".freeze
REMOTE_ADDR =
"REMOTE_ADDR".freeze
HTTP_X_FORWARDED_FOR =
"HTTP_X_FORWARDED_FOR".freeze
HTTP_IF_MODIFIED_SINCE =
"HTTP_IF_MODIFIED_SINCE".freeze
HTTP_IF_NONE_MATCH =
"HTTP_IF_NONE_MATCH".freeze
REDIRECT =
"HTTP/1.1 302 Found\r\nLocation: %s\r\nConnection: close\r\n\r\n".freeze
HOST =
"HOST".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
SERVER_PROTOCOL =
"SERVER_PROTOCOL".freeze
HTTP_11 =
"HTTP/1.1".freeze
HTTP_10 =
"HTTP/1.0".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
HTTP =
"http".freeze
HTTPS =
"https".freeze
HTTPS_KEY =
"HTTPS".freeze
HTTP_VERSION =
"HTTP_VERSION".freeze
HTTP_CONNECTION =
"HTTP_CONNECTION".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
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
COLON =
": ".freeze
NEWLINE =
"\n".freeze
HIJACK_P =
"rack.hijack?".freeze
HIJACK =
"rack.hijack".freeze
HIJACK_IO =
"rack.hijack_io".freeze