Server : LiteSpeed System : Linux premium163.web-hosting.com 4.18.0-513.18.1.lve.el8.x86_64 #1 SMP Thu Feb 22 12:55:50 UTC 2024 x86_64 User : infihsqw ( 644) PHP Version : 8.1.29 Disable Function : NONE Directory : /opt/cpanel/ea-ruby27/root/usr/share/gems/doc/rack-2.2.8/rdoc/Rack/ |
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Rack::Server - rack-2.2.8 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">Object
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-default_middleware_by_environment">::default_middleware_by_environment</a>
<li ><a href="#method-c-logging_middleware">::logging_middleware</a>
<li ><a href="#method-c-middleware">::middleware</a>
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-c-start">::start</a>
<li ><a href="#method-i-app">#app</a>
<li ><a href="#method-i-build_app">#build_app</a>
<li ><a href="#method-i-build_app_and_options_from_config">#build_app_and_options_from_config</a>
<li ><a href="#method-i-build_app_from_string">#build_app_from_string</a>
<li ><a href="#method-i-check_pid-21">#check_pid!</a>
<li ><a href="#method-i-daemonize_app">#daemonize_app</a>
<li ><a href="#method-i-default_options">#default_options</a>
<li ><a href="#method-i-handle_profiling">#handle_profiling</a>
<li ><a href="#method-i-make_profile_name">#make_profile_name</a>
<li ><a href="#method-i-middleware">#middleware</a>
<li ><a href="#method-i-opt_parser">#opt_parser</a>
<li ><a href="#method-i-options">#options</a>
<li ><a href="#method-i-parse_options">#parse_options</a>
<li ><a href="#method-i-pidfile_process_status">#pidfile_process_status</a>
<li ><a href="#method-i-server">#server</a>
<li ><a href="#method-i-start">#start</a>
<li ><a href="#method-i-wrapped_app">#wrapped_app</a>
<li ><a href="#method-i-write_pid">#write_pid</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Rack::Server">
<h1 id="class-Rack::Server" class="class">
class Rack::Server
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-options" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">options</span><span
class="attribute-access-type">[W]</span>
</div>
<div class="method-description">
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-default_middleware_by_environment" class="method-detail ">
<div class="method-heading">
<span class="method-name">default_middleware_by_environment</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="default_middleware_by_environment-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 259</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">default_middleware_by_environment</span>
<span class="ruby-identifier">m</span> = <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">h</span>, <span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>[<span class="ruby-identifier">k</span>] = []}
<span class="ruby-identifier">m</span>[<span class="ruby-string">"deployment"</span>] = [
[<span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">ContentLength</span>],
<span class="ruby-identifier">logging_middleware</span>,
[<span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">TempfileReaper</span>]
]
<span class="ruby-identifier">m</span>[<span class="ruby-string">"development"</span>] = [
[<span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">ContentLength</span>],
<span class="ruby-identifier">logging_middleware</span>,
[<span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">ShowExceptions</span>],
[<span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Lint</span>],
[<span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">TempfileReaper</span>]
]
<span class="ruby-identifier">m</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-logging_middleware" class="method-detail ">
<div class="method-heading">
<span class="method-name">logging_middleware</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="logging_middleware-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 253</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">logging_middleware</span>
<span class="ruby-identifier">lambda</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">server</span><span class="ruby-operator">|</span>
<span class="ruby-regexp">/CGI/</span>.<span class="ruby-identifier">match?</span>(<span class="ruby-identifier">server</span>.<span class="ruby-identifier">server</span>.<span class="ruby-identifier">name</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">server</span>.<span class="ruby-identifier">options</span>[<span class="ruby-value">:quiet</span>] <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> [<span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">CommonLogger</span>, <span class="ruby-identifier">$stderr</span>]
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-middleware" class="method-detail ">
<div class="method-heading">
<span class="method-name">middleware</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="middleware-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 277</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">middleware</span>
<span class="ruby-identifier">default_middleware_by_environment</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(options = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="Server/Options.html"><code>Options</code></a> may include:</p>
<ul><li>
<p>:app</p>
<pre class="ruby"><span class="ruby-identifier">a</span> <span class="ruby-identifier">rack</span> <span class="ruby-identifier">application</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">run</span> (<span class="ruby-identifier">overrides</span> <span class="ruby-value">:config</span> <span class="ruby-keyword">and</span> <span class="ruby-value">:builder</span>)
</pre>
</li><li>
<p>:builder</p>
<pre class="ruby"><span class="ruby-identifier">a</span> <span class="ruby-identifier">string</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">evaluate</span> <span class="ruby-identifier">a</span> <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Builder</span> <span class="ruby-identifier">from</span>
</pre>
</li><li>
<p>:config</p>
<pre>a rackup configuration file path to load (.ru)</pre>
</li><li>
<p>:environment</p>
<pre>this selects the middleware that will be wrapped around
your application. Default options available are:
- development: CommonLogger, ShowExceptions, and Lint
- deployment: CommonLogger
- none: no extra middleware
note: when the server is a cgi server, CommonLogger is not included.</pre>
</li><li>
<p>:server</p>
<pre class="ruby"><span class="ruby-identifier">choose</span> <span class="ruby-identifier">a</span> <span class="ruby-identifier">specific</span> <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Handler</span>, <span class="ruby-identifier">e</span>.<span class="ruby-identifier">g</span>. <span class="ruby-identifier">cgi</span>, <span class="ruby-identifier">fcgi</span>, <span class="ruby-identifier">webrick</span>
</pre>
</li><li>
<p>:daemonize</p>
<pre>if true, the server will daemonize itself (fork, detach, etc)</pre>
</li><li>
<p>:pid</p>
<pre class="ruby"><span class="ruby-identifier">path</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">write</span> <span class="ruby-identifier">a</span> <span class="ruby-identifier">pid</span> <span class="ruby-identifier">file</span> <span class="ruby-identifier">after</span> <span class="ruby-identifier">daemonize</span>
</pre>
</li><li>
<p>:Host</p>
<pre class="ruby"><span class="ruby-identifier">the</span> <span class="ruby-identifier">host</span> <span class="ruby-identifier">address</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">bind</span> <span class="ruby-identifier">to</span> (<span class="ruby-identifier">used</span> <span class="ruby-identifier">by</span> <span class="ruby-identifier">supporting</span> <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Handler</span>)
</pre>
</li><li>
<p>:Port</p>
<pre class="ruby"><span class="ruby-identifier">the</span> <span class="ruby-identifier">port</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">bind</span> <span class="ruby-identifier">to</span> (<span class="ruby-identifier">used</span> <span class="ruby-identifier">by</span> <span class="ruby-identifier">supporting</span> <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Handler</span>)
</pre>
</li><li>
<p>:AccessLog</p>
<pre>webrick access log options (or supporting Rack::Handler)</pre>
</li><li>
<p>:debug</p>
<pre class="ruby"><span class="ruby-identifier">turn</span> <span class="ruby-identifier">on</span> <span class="ruby-identifier">debug</span> <span class="ruby-identifier">output</span> (<span class="ruby-identifier">$DEBUG</span> = <span class="ruby-keyword">true</span>)
</pre>
</li><li>
<p>:warn</p>
<pre class="ruby"><span class="ruby-identifier">turn</span> <span class="ruby-identifier">on</span> <span class="ruby-identifier">warnings</span> (<span class="ruby-identifier">$-w</span> = <span class="ruby-keyword">true</span>)
</pre>
</li><li>
<p>:include</p>
<pre class="ruby"><span class="ruby-identifier">add</span> <span class="ruby-identifier">given</span> <span class="ruby-identifier">paths</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">$LOAD_PATH</span>
</pre>
</li><li>
<p>:require</p>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">given</span> <span class="ruby-identifier">libraries</span>
</pre>
</li></ul>
<p>Additional options for profiling app initialization include:</p>
<ul><li>
<p>:heapfile</p>
<pre>location for ObjectSpace.dump_all to write the output to</pre>
</li><li>
<p>:profile_file</p>
<pre>location for CPU/Memory (StackProf) profile output (defaults to a tempfile)</pre>
</li><li>
<p>:profile_mode</p>
<pre class="ruby"><span class="ruby-constant">StackProf</span> <span class="ruby-identifier">profile</span> <span class="ruby-identifier">mode</span> (<span class="ruby-identifier">cpu</span><span class="ruby-operator">|</span><span class="ruby-identifier">wall</span><span class="ruby-operator">|</span><span class="ruby-identifier">object</span>)
</pre>
</li></ul>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 215</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">options</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@ignore_options</span> = []
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>
<span class="ruby-ivar">@use_default_options</span> = <span class="ruby-keyword">false</span>
<span class="ruby-ivar">@options</span> = <span class="ruby-identifier">options</span>
<span class="ruby-ivar">@app</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:app</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:app</span>]
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">argv</span> = <span class="ruby-keyword">defined?</span>(<span class="ruby-constant">SPEC_ARGV</span>) <span class="ruby-operator">?</span> <span class="ruby-constant">SPEC_ARGV</span> <span class="ruby-operator">:</span> <span class="ruby-constant">ARGV</span>
<span class="ruby-ivar">@use_default_options</span> = <span class="ruby-keyword">true</span>
<span class="ruby-ivar">@options</span> = <span class="ruby-identifier">parse_options</span>(<span class="ruby-identifier">argv</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-start" class="method-detail ">
<div class="method-heading">
<span class="method-name">start</span><span
class="method-args">(options = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Start a new rack server (like running rackup). This will parse ARGV and provide standard ARGV rackup options, defaulting to load 'config.ru'.</p>
<p>Providing an options hash will prevent ARGV parsing and will not include any default options.</p>
<p>This method can be used to very easily launch a CGI application, for example:</p>
<pre class="ruby"><span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Server</span>.<span class="ruby-identifier">start</span>(
<span class="ruby-value">:app</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">lambda</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">e</span><span class="ruby-operator">|</span>
[<span class="ruby-value">200</span>, {<span class="ruby-string">'Content-Type'</span> <span class="ruby-operator">=></span> <span class="ruby-string">'text/html'</span>}, [<span class="ruby-string">'hello world'</span>]]
<span class="ruby-keyword">end</span>,
<span class="ruby-value">:server</span> <span class="ruby-operator">=></span> <span class="ruby-string">'cgi'</span>
)
</pre>
<p>Further options available here are documented on Rack::Server#initialize</p>
<div class="method-source-code" id="start-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 167</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">start</span>(<span class="ruby-identifier">options</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>).<span class="ruby-identifier">start</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-app" class="method-detail ">
<div class="method-heading">
<span class="method-name">app</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="app-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 248</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">app</span>
<span class="ruby-ivar">@app</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:builder</span>] <span class="ruby-operator">?</span> <span class="ruby-identifier">build_app_from_string</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">build_app_and_options_from_config</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-default_options" class="method-detail ">
<div class="method-heading">
<span class="method-name">default_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="default_options-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 234</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">default_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-value">environment:</span> <span class="ruby-identifier">environment</span>,
<span class="ruby-value">pid:</span> <span class="ruby-keyword">nil</span>,
<span class="ruby-value">Port:</span> <span class="ruby-value">9292</span>,
<span class="ruby-value">Host:</span> <span class="ruby-identifier">default_host</span>,
<span class="ruby-value">AccessLog:</span> [],
<span class="ruby-value">config:</span> <span class="ruby-string">"config.ru"</span>
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-middleware" class="method-detail ">
<div class="method-heading">
<span class="method-name">middleware</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="middleware-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 282</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">middleware</span>
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">middleware</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-options" class="method-detail ">
<div class="method-heading">
<span class="method-name">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="options-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 229</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">options</span>
<span class="ruby-identifier">merged_options</span> = <span class="ruby-ivar">@use_default_options</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">default_options</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-ivar">@options</span>) <span class="ruby-operator">:</span> <span class="ruby-ivar">@options</span>
<span class="ruby-identifier">merged_options</span>.<span class="ruby-identifier">reject</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-ivar">@ignore_options</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">k</span>) }
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-server" class="method-detail ">
<div class="method-heading">
<span class="method-name">server</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="server-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 330</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">server</span>
<span class="ruby-ivar">@_server</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Handler</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:server</span>])
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@_server</span>
<span class="ruby-ivar">@_server</span> = <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Handler</span>.<span class="ruby-identifier">default</span>
<span class="ruby-comment"># We already speak FastCGI</span>
<span class="ruby-ivar">@ignore_options</span> = [<span class="ruby-value">:File</span>, <span class="ruby-value">:Port</span>] <span class="ruby-keyword">if</span> <span class="ruby-ivar">@_server</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">==</span> <span class="ruby-string">'Rack::Handler::FastCGI'</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@_server</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-start" class="method-detail ">
<div class="method-heading">
<span class="method-name">start</span><span
class="method-args">(&block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="start-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 286</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">start</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:warn</span>]
<span class="ruby-identifier">$-w</span> = <span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">includes</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:include</span>]
<span class="ruby-identifier">$LOAD_PATH</span>.<span class="ruby-identifier">unshift</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">includes</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-constant">Array</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:require</span>]).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">library</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">require</span> <span class="ruby-identifier">library</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:debug</span>]
<span class="ruby-identifier">$DEBUG</span> = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'pp'</span>
<span class="ruby-identifier">p</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:server</span>]
<span class="ruby-identifier">pp</span> <span class="ruby-identifier">wrapped_app</span>
<span class="ruby-identifier">pp</span> <span class="ruby-identifier">app</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">check_pid!</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pid</span>]
<span class="ruby-comment"># Touch the wrapped app, so that the config.ru is loaded before</span>
<span class="ruby-comment"># daemonization (i.e. before chdir, etc).</span>
<span class="ruby-identifier">handle_profiling</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:heapfile</span>], <span class="ruby-identifier">options</span>[<span class="ruby-value">:profile_mode</span>], <span class="ruby-identifier">options</span>[<span class="ruby-value">:profile_file</span>]) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">wrapped_app</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">daemonize_app</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:daemonize</span>]
<span class="ruby-identifier">write_pid</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:pid</span>]
<span class="ruby-identifier">trap</span>(<span class="ruby-value">:INT</span>) <span class="ruby-keyword">do</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">server</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:shutdown</span>)
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">shutdown</span>
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">exit</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">run</span>(<span class="ruby-identifier">wrapped_app</span>, <span class="ruby-operator">**</span><span class="ruby-identifier">options</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-build_app" class="method-detail ">
<div class="method-heading">
<span class="method-name">build_app</span><span
class="method-args">(app)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="build_app-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 411</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_app</span>(<span class="ruby-identifier">app</span>)
<span class="ruby-identifier">middleware</span>[<span class="ruby-identifier">options</span>[<span class="ruby-value">:environment</span>]].<span class="ruby-identifier">reverse_each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">middleware</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">middleware</span> = <span class="ruby-identifier">middleware</span>.<span class="ruby-identifier">call</span>(<span class="ruby-keyword">self</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">middleware</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
<span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">middleware</span>
<span class="ruby-identifier">klass</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span> = <span class="ruby-identifier">middleware</span>
<span class="ruby-identifier">app</span> = <span class="ruby-identifier">klass</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">app</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">app</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-build_app_and_options_from_config" class="method-detail ">
<div class="method-heading">
<span class="method-name">build_app_and_options_from_config</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="build_app_and_options_from_config-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 344</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_app_and_options_from_config</span>
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:config</span>]
<span class="ruby-identifier">abort</span> <span class="ruby-node">"configuration #{options[:config]} not found"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">app</span>, <span class="ruby-identifier">options</span> = <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Builder</span>.<span class="ruby-identifier">parse_file</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">options</span>[<span class="ruby-value">:config</span>], <span class="ruby-identifier">opt_parser</span>)
<span class="ruby-ivar">@options</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">options</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">old</span>, <span class="ruby-identifier">new</span><span class="ruby-operator">|</span> <span class="ruby-identifier">old</span> }
<span class="ruby-identifier">app</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-build_app_from_string" class="method-detail ">
<div class="method-heading">
<span class="method-name">build_app_from_string</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="build_app_from_string-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 392</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">build_app_from_string</span>
<span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">Builder</span>.<span class="ruby-identifier">new_from_string</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">options</span>[<span class="ruby-value">:builder</span>])
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-check_pid-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">check_pid!</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="check_pid-21-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 440</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">check_pid!</span>
<span class="ruby-keyword">case</span> <span class="ruby-identifier">pidfile_process_status</span>
<span class="ruby-keyword">when</span> <span class="ruby-value">:running</span>, <span class="ruby-value">:not_owned</span>
<span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"A server is already running. Check #{options[:pid]}."</span>
<span class="ruby-identifier">exit</span>(<span class="ruby-value">1</span>)
<span class="ruby-keyword">when</span> <span class="ruby-value">:dead</span>
<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pid</span>])
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-daemonize_app" class="method-detail ">
<div class="method-heading">
<span class="method-name">daemonize_app</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="daemonize_app-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 425</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">daemonize_app</span>
<span class="ruby-comment"># Cannot be covered as it forks</span>
<span class="ruby-comment"># :nocov:</span>
<span class="ruby-constant">Process</span>.<span class="ruby-identifier">daemon</span>
<span class="ruby-comment"># :nocov:</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-handle_profiling" class="method-detail ">
<div class="method-heading">
<span class="method-name">handle_profiling</span><span
class="method-args">(heapfile, profile_mode, filename) { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="handle_profiling-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 354</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">handle_profiling</span>(<span class="ruby-identifier">heapfile</span>, <span class="ruby-identifier">profile_mode</span>, <span class="ruby-identifier">filename</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">heapfile</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">"objspace"</span>
<span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">trace_object_allocations_start</span>
<span class="ruby-keyword">yield</span>
<span class="ruby-constant">GC</span>.<span class="ruby-identifier">start</span>
<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">heapfile</span>, <span class="ruby-string">"w"</span>) { <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-constant">ObjectSpace</span>.<span class="ruby-identifier">dump_all</span>(<span class="ruby-value">output:</span> <span class="ruby-identifier">f</span>) }
<span class="ruby-identifier">exit</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">profile_mode</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">"stackprof"</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">"tempfile"</span>
<span class="ruby-identifier">make_profile_name</span>(<span class="ruby-identifier">filename</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">filename</span><span class="ruby-operator">|</span>
<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">filename</span>, <span class="ruby-string">"w"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
<span class="ruby-constant">StackProf</span>.<span class="ruby-identifier">run</span>(<span class="ruby-value">mode:</span> <span class="ruby-identifier">profile_mode</span>, <span class="ruby-value">out:</span> <span class="ruby-identifier">f</span>) <span class="ruby-keyword">do</span>
<span class="ruby-keyword">yield</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">"Profile written to: #{filename}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">exit</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">yield</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-make_profile_name" class="method-detail ">
<div class="method-heading">
<span class="method-name">make_profile_name</span><span
class="method-args">(filename) { |filename| ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="make_profile_name-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 382</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">make_profile_name</span>(<span class="ruby-identifier">filename</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">filename</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">filename</span>
<span class="ruby-keyword">else</span>
<span class="ruby-operator">::</span><span class="ruby-constant">Dir</span><span class="ruby-operator">::</span><span class="ruby-constant">Tmpname</span>.<span class="ruby-identifier">create</span>(<span class="ruby-string">"profile.dump"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">tmpname</span>, <span class="ruby-identifier">_</span>, <span class="ruby-identifier">_</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">tmpname</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-opt_parser" class="method-detail ">
<div class="method-heading">
<span class="method-name">opt_parser</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="opt_parser-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 407</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">opt_parser</span>
<span class="ruby-constant">Options</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-parse_options" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse_options</span><span
class="method-args">(args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="parse_options-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 396</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse_options</span>(<span class="ruby-identifier">args</span>)
<span class="ruby-comment"># Don't evaluate CGI ISINDEX parameters.</span>
<span class="ruby-comment"># http://www.meb.uni-bonn.de/docs/cgi/cl.html</span>
<span class="ruby-identifier">args</span>.<span class="ruby-identifier">clear</span> <span class="ruby-keyword">if</span> <span class="ruby-constant">ENV</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-constant">REQUEST_METHOD</span>)
<span class="ruby-ivar">@options</span> = <span class="ruby-identifier">opt_parser</span>.<span class="ruby-identifier">parse!</span>(<span class="ruby-identifier">args</span>)
<span class="ruby-ivar">@options</span>[<span class="ruby-value">:config</span>] = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:config</span>])
<span class="ruby-constant">ENV</span>[<span class="ruby-string">"RACK_ENV"</span>] = <span class="ruby-identifier">options</span>[<span class="ruby-value">:environment</span>]
<span class="ruby-ivar">@options</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-pidfile_process_status" class="method-detail ">
<div class="method-heading">
<span class="method-name">pidfile_process_status</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="pidfile_process_status-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 450</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pidfile_process_status</span>
<span class="ruby-keyword">return</span> <span class="ruby-value">:exited</span> <span class="ruby-keyword">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pid</span>])
<span class="ruby-identifier">pid</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pid</span>]).<span class="ruby-identifier">to_i</span>
<span class="ruby-keyword">return</span> <span class="ruby-value">:dead</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">pid</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-constant">Process</span>.<span class="ruby-identifier">kill</span>(<span class="ruby-value">0</span>, <span class="ruby-identifier">pid</span>)
<span class="ruby-value">:running</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ESRCH</span>
<span class="ruby-value">:dead</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EPERM</span>
<span class="ruby-value">:not_owned</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-wrapped_app" class="method-detail ">
<div class="method-heading">
<span class="method-name">wrapped_app</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="wrapped_app-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 421</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">wrapped_app</span>
<span class="ruby-ivar">@wrapped_app</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">build_app</span> <span class="ruby-identifier">app</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-write_pid" class="method-detail ">
<div class="method-heading">
<span class="method-name">write_pid</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="write_pid-source">
<pre><span class="ruby-comment"># File lib/rack/server.rb, line 432</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">write_pid</span>
<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pid</span>], <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">CREAT</span> <span class="ruby-operator">|</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">EXCL</span> <span class="ruby-operator">|</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">WRONLY</span> ){ <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-node">"#{Process.pid}"</span>) }
<span class="ruby-identifier">at_exit</span> { <span class="ruby-operator">::</span><span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_f</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:pid</span>]) }
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EEXIST</span>
<span class="ruby-identifier">check_pid!</span>
<span class="ruby-keyword">retry</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>