Your IP : 18.119.255.183
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Rack::Handler::WEBrick - rack-2.2.10 Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>
<link href="../../css/fonts.css" rel="stylesheet">
<link href="../../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../../table_of_contents.html#pages">Pages</a>
<a href="../../table_of_contents.html#classes">Classes</a>
<a href="../../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link">WEBrick::HTTPServlet::AbstractServlet
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li class="calls-super" ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-run">::run</a>
<li ><a href="#method-c-shutdown">::shutdown</a>
<li ><a href="#method-c-valid_options">::valid_options</a>
<li ><a href="#method-i-service">#service</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Rack::Handler::WEBrick">
<h1 id="class-Rack::Handler::WEBrick" class="class">
class Rack::Handler::WEBrick
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(server, app)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rack/handler/webrick.rb, line 61</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">server</span>, <span class="ruby-identifier">app</span>)
<span class="ruby-keyword">super</span> <span class="ruby-identifier">server</span>
<span class="ruby-ivar">@app</span> = <span class="ruby-identifier">app</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-run" class="method-detail ">
<div class="method-heading">
<span class="method-name">run</span><span
class="method-args">(app, **options) { |server| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="run-source">
<pre><span class="ruby-comment"># File lib/rack/handler/webrick.rb, line 26</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">run</span>(<span class="ruby-identifier">app</span>, <span class="ruby-operator">**</span><span class="ruby-identifier">options</span>)
<span class="ruby-identifier">environment</span> = <span class="ruby-constant">ENV</span>[<span class="ruby-string">'RACK_ENV'</span>] <span class="ruby-operator">||</span> <span class="ruby-string">'development'</span>
<span class="ruby-identifier">default_host</span> = <span class="ruby-identifier">environment</span> <span class="ruby-operator">==</span> <span class="ruby-string">'development'</span> <span class="ruby-operator">?</span> <span class="ruby-string">'localhost'</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">options</span>[<span class="ruby-value">:BindAddress</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:Host</span>]
<span class="ruby-identifier">options</span>[<span class="ruby-value">:BindAddress</span>] = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:Host</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">default_host</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">options</span>[<span class="ruby-value">:Port</span>] <span class="ruby-operator">||=</span> <span class="ruby-value">8080</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:SSLEnable</span>]
<span class="ruby-identifier">require</span> <span class="ruby-string">'webrick/https'</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@server</span> = <span class="ruby-operator">::</span><span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTPServer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
<span class="ruby-ivar">@server</span>.<span class="ruby-identifier">mount</span> <span class="ruby-string">"/"</span>, <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Handler</span><span class="ruby-operator">::</span><span class="ruby-constant">WEBrick</span>, <span class="ruby-identifier">app</span>
<span class="ruby-keyword">yield</span> <span class="ruby-ivar">@server</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
<span class="ruby-ivar">@server</span>.<span class="ruby-identifier">start</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-shutdown" class="method-detail ">
<div class="method-heading">
<span class="method-name">shutdown</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="shutdown-source">
<pre><span class="ruby-comment"># File lib/rack/handler/webrick.rb, line 54</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">shutdown</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@server</span>
<span class="ruby-ivar">@server</span>.<span class="ruby-identifier">shutdown</span>
<span class="ruby-ivar">@server</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-valid_options" class="method-detail ">
<div class="method-heading">
<span class="method-name">valid_options</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="valid_options-source">
<pre><span class="ruby-comment"># File lib/rack/handler/webrick.rb, line 44</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">valid_options</span>
<span class="ruby-identifier">environment</span> = <span class="ruby-constant">ENV</span>[<span class="ruby-string">'RACK_ENV'</span>] <span class="ruby-operator">||</span> <span class="ruby-string">'development'</span>
<span class="ruby-identifier">default_host</span> = <span class="ruby-identifier">environment</span> <span class="ruby-operator">==</span> <span class="ruby-string">'development'</span> <span class="ruby-operator">?</span> <span class="ruby-string">'localhost'</span> <span class="ruby-operator">:</span> <span class="ruby-string">'0.0.0.0'</span>
{
<span class="ruby-string">"Host=HOST"</span> <span class="ruby-operator">=></span> <span class="ruby-node">"Hostname to listen on (default: #{default_host})"</span>,
<span class="ruby-string">"Port=PORT"</span> <span class="ruby-operator">=></span> <span class="ruby-string">"Port to listen on (default: 8080)"</span>,
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-service" class="method-detail ">
<div class="method-heading">
<span class="method-name">service</span><span
class="method-args">(req, res)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="service-source">
<pre><span class="ruby-comment"># File lib/rack/handler/webrick.rb, line 66</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">service</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">rack</span> = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">env</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">meta_vars</span>
<span class="ruby-identifier">env</span>.<span class="ruby-identifier">delete_if</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">nil?</span> }
<span class="ruby-identifier">rack_input</span> = <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">req</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">to_s</span>)
<span class="ruby-identifier">rack_input</span>.<span class="ruby-identifier">set_encoding</span>(<span class="ruby-constant">Encoding</span><span class="ruby-operator">::</span><span class="ruby-constant">BINARY</span>)
<span class="ruby-identifier">env</span>.<span class="ruby-identifier">update</span>(
<span class="ruby-constant">RACK_VERSION</span> <span class="ruby-operator">=></span> <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>,
<span class="ruby-constant">RACK_INPUT</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">rack_input</span>,
<span class="ruby-constant">RACK_ERRORS</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">$stderr</span>,
<span class="ruby-constant">RACK_MULTITHREAD</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>,
<span class="ruby-constant">RACK_MULTIPROCESS</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>,
<span class="ruby-constant">RACK_RUNONCE</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">false</span>,
<span class="ruby-constant">RACK_URL_SCHEME</span> <span class="ruby-operator">=></span> [<span class="ruby-string">"yes"</span>, <span class="ruby-string">"on"</span>, <span class="ruby-string">"1"</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">env</span>[<span class="ruby-constant">HTTPS</span>]) <span class="ruby-operator">?</span> <span class="ruby-string">"https"</span> <span class="ruby-operator">:</span> <span class="ruby-string">"http"</span>,
<span class="ruby-constant">RACK_IS_HIJACK</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">true</span>,
<span class="ruby-constant">RACK_HIJACK</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">lambda</span> { <span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>, <span class="ruby-string">"only partial hijack is supported."</span>},
<span class="ruby-constant">RACK_HIJACK_IO</span> <span class="ruby-operator">=></span> <span class="ruby-keyword">nil</span>
)
<span class="ruby-identifier">env</span>[<span class="ruby-constant">HTTP_VERSION</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">env</span>[<span class="ruby-constant">SERVER_PROTOCOL</span>]
<span class="ruby-identifier">env</span>[<span class="ruby-constant">QUERY_STRING</span>] <span class="ruby-operator">||=</span> <span class="ruby-string">""</span>
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">env</span>[<span class="ruby-constant">PATH_INFO</span>] <span class="ruby-operator">==</span> <span class="ruby-string">""</span>
<span class="ruby-identifier">path</span>, <span class="ruby-identifier">n</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">request_uri</span>.<span class="ruby-identifier">path</span>, <span class="ruby-identifier">env</span>[<span class="ruby-constant">SCRIPT_NAME</span>].<span class="ruby-identifier">length</span>
<span class="ruby-identifier">env</span>[<span class="ruby-constant">PATH_INFO</span>] = <span class="ruby-identifier">path</span>[<span class="ruby-identifier">n</span>, <span class="ruby-identifier">path</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">n</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">env</span>[<span class="ruby-constant">REQUEST_PATH</span>] <span class="ruby-operator">||=</span> [<span class="ruby-identifier">env</span>[<span class="ruby-constant">SCRIPT_NAME</span>], <span class="ruby-identifier">env</span>[<span class="ruby-constant">PATH_INFO</span>]].<span class="ruby-identifier">join</span>
<span class="ruby-identifier">status</span>, <span class="ruby-identifier">headers</span>, <span class="ruby-identifier">body</span> = <span class="ruby-ivar">@app</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">status</span> = <span class="ruby-identifier">status</span>.<span class="ruby-identifier">to_i</span>
<span class="ruby-identifier">io_lambda</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-identifier">headers</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">vs</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">k</span> <span class="ruby-operator">==</span> <span class="ruby-constant">RACK_HIJACK</span>
<span class="ruby-identifier">io_lambda</span> = <span class="ruby-identifier">vs</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">k</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-string">"set-cookie"</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">cookies</span>.<span class="ruby-identifier">concat</span> <span class="ruby-identifier">vs</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"\n"</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-comment"># Since WEBrick won't accept repeated headers,</span>
<span class="ruby-comment"># merge the values per RFC 1945 section 4.2.</span>
<span class="ruby-identifier">res</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">vs</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"\n"</span>).<span class="ruby-identifier">join</span>(<span class="ruby-string">", "</span>)
<span class="ruby-keyword">end</span>
}
<span class="ruby-keyword">if</span> <span class="ruby-identifier">io_lambda</span>
<span class="ruby-identifier">rd</span>, <span class="ruby-identifier">wr</span> = <span class="ruby-constant">IO</span>.<span class="ruby-identifier">pipe</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">body</span> = <span class="ruby-identifier">rd</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">chunked</span> = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">io_lambda</span>.<span class="ruby-identifier">call</span> <span class="ruby-identifier">wr</span>
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">body</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:to_path</span>)
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">body</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">body</span>.<span class="ruby-identifier">to_path</span>, <span class="ruby-string">'rb'</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">body</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">body</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">part</span>
}
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-identifier">body</span>.<span class="ruby-identifier">close</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">body</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-value">:close</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>