Class: Rack::Chunked
Overview
Middleware that applies chunked transfer encoding to response bodies when the response does not include a content-length header.
This supports the trailer response header to allow the use of trailing headers in the chunked encoding. However, using this requires you manually specify a response body that supports a trailers
method. Example:
[200, { 'trailer' => 'expires'}, ["Hello", "World"]]
# error raised
body = ["Hello", "World"]
def body.trailers
{ 'expires' => Time.now.to_s }
end
[200, { 'trailer' => 'expires'}, body]
# No exception raised
Defined Under Namespace
Classes: Body, TrailerBody
Constant Summary
Constants included from Utils
Utils::COMMON_SEP, Utils::DEFAULT_SEP, Utils::ESCAPE_HTML, Utils::ESCAPE_HTML_PATTERN, Utils::HTTP_STATUS_CODES, Utils::InvalidParameterError, Utils::KeySpaceConstrainedParams, Utils::NULL_BYTE, Utils::PATH_SEPS, Utils::ParameterTypeError, Utils::ParamsTooDeepError, Utils::STATUS_WITH_NO_ENTITY_BODY, Utils::SYMBOL_TO_STATUS_CODE
Instance Method Summary collapse
-
#call(env) ⇒ Object
If the rack app returns a response that should have a body, but does not have content-length or transfer-encoding headers, modify the response to use chunked transfer-encoding.
-
#chunkable_version?(ver) ⇒ Boolean
Whether the HTTP version supports chunked encoding (HTTP 1.1 does).
-
#initialize(app) ⇒ Chunked
constructor
A new instance of Chunked.
Methods included from Utils
add_cookie_to_header, add_remove_cookie_to_header, best_q_match, build_nested_query, build_query, byte_ranges, clean_path_info, #clock_time, delete_cookie_header!, delete_set_cookie_header, delete_set_cookie_header!, escape, escape_html, escape_path, forwarded_values, get_byte_ranges, key_space_limit, key_space_limit=, make_delete_cookie_header, param_depth_limit, param_depth_limit=, parse_cookies, parse_cookies_header, parse_nested_query, parse_query, q_values, rfc2822, #secure_compare, select_best_encoding, set_cookie_header, set_cookie_header!, status_code, unescape, unescape_path, valid_path?
Constructor Details
#initialize(app) ⇒ Chunked
Returns a new instance of Chunked.
82 83 84 |
# File 'lib/rack/chunked.rb', line 82 def initialize(app) @app = app end |
Instance Method Details
#call(env) ⇒ Object
If the rack app returns a response that should have a body, but does not have content-length or transfer-encoding headers, modify the response to use chunked transfer-encoding.
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/rack/chunked.rb', line 101 def call(env) status, headers, body = response = @app.call(env) if chunkable_version?(env[SERVER_PROTOCOL]) && !STATUS_WITH_NO_ENTITY_BODY.key?(status.to_i) && !headers[CONTENT_LENGTH] && !headers[TRANSFER_ENCODING] headers[TRANSFER_ENCODING] = 'chunked' if headers['trailer'] response[2] = TrailerBody.new(body) else response[2] = Body.new(body) end end response end |
#chunkable_version?(ver) ⇒ Boolean
Whether the HTTP version supports chunked encoding (HTTP 1.1 does).
87 88 89 90 91 92 93 94 95 96 |
# File 'lib/rack/chunked.rb', line 87 def chunkable_version?(ver) case ver # pre-HTTP/1.0 (informally "HTTP/0.9") HTTP requests did not have # a version (nor response headers) when 'HTTP/1.0', nil, 'HTTP/0.9' false else true end end |