File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/HTTPServer.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class WEBrick::HTTPServer - RDoc 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"><a href="GenericServer.html">WEBrick::GenericServer</a>
</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-i-access_log">#access_log</a>
<li ><a href="#method-i-create_request">#create_request</a>
<li ><a href="#method-i-create_response">#create_response</a>
<li ><a href="#method-i-do_OPTIONS">#do_OPTIONS</a>
<li ><a href="#method-i-lookup_server">#lookup_server</a>
<li ><a href="#method-i-mount">#mount</a>
<li ><a href="#method-i-mount_proc">#mount_proc</a>
<li ><a href="#method-i-run">#run</a>
<li ><a href="#method-i-search_servlet">#search_servlet</a>
<li ><a href="#method-i-service">#service</a>
<li ><a href="#method-i-ssl_servername_callback">#ssl_servername_callback</a>
<li ><a href="#method-i-umount">#umount</a>
<li ><a href="#method-i-unmount">#unmount</a>
<li ><a href="#method-i-virtual_host">#virtual_host</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-WEBrick::HTTPServer">
<h1 id="class-WEBrick::HTTPServer" class="class">
class WEBrick::HTTPServer
</h1>
<section class="description">
<p>An HTTP Server</p>
</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">(config={}, default=Config::HTTP)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new HTTP server according to <code>config</code></p>
<p>An HTTP server uses the following attributes:</p>
<dl class="rdoc-list note-list"><dt>:AccessLog
<dd>
<p>An array of access logs. See <a href="AccessLog.html"><code>WEBrick::AccessLog</code></a></p>
</dd><dt>:BindAddress
<dd>
<p>Local address for the server to bind to</p>
</dd><dt>:DocumentRoot
<dd>
<p>Root path to serve files from</p>
</dd><dt>:DocumentRootOptions
<dd>
<p>Options for the default <a href="HTTPServlet/FileHandler.html"><code>HTTPServlet::FileHandler</code></a></p>
</dd><dt>:HTTPVersion
<dd>
<p>The HTTP version of this server</p>
</dd><dt>:Port
<dd>
<p>Port to listen on</p>
</dd><dt>:RequestCallback
<dd>
<p>Called with a request and response before each request is serviced.</p>
</dd><dt>:RequestTimeout
<dd>
<p>Maximum time to wait between requests</p>
</dd><dt>:ServerAlias
<dd>
<p><a href="../Array.html"><code>Array</code></a> of alternate names for this server for virtual hosting</p>
</dd><dt>:ServerName
<dd>
<p>Name for this server for virtual hosting</p>
</dd></dl>
<div class="method-calls-super">
Calls superclass method
<a href="GenericServer.html#method-c-new"><code>WEBrick::GenericServer::new</code></a>
</div>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/webrick/httpserver.rb, line 46</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">config</span>={}, <span class="ruby-identifier">default</span>=<span class="ruby-constant">Config</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span>)
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">config</span>, <span class="ruby-identifier">default</span>)
<span class="ruby-ivar">@http_version</span> = <span class="ruby-constant">HTTPVersion</span><span class="ruby-operator">::</span><span class="ruby-identifier">convert</span>(<span class="ruby-ivar">@config</span>[<span class="ruby-value">:HTTPVersion</span>])
<span class="ruby-ivar">@mount_tab</span> = <span class="ruby-constant">MountTable</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-value">:DocumentRoot</span>]
<span class="ruby-identifier">mount</span>(<span class="ruby-string">"/"</span>, <span class="ruby-constant">HTTPServlet</span><span class="ruby-operator">::</span><span class="ruby-constant">FileHandler</span>, <span class="ruby-ivar">@config</span>[<span class="ruby-value">:DocumentRoot</span>],
<span class="ruby-ivar">@config</span>[<span class="ruby-value">:DocumentRootOptions</span>])
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@config</span>[<span class="ruby-value">:AccessLog</span>]
<span class="ruby-ivar">@config</span>[<span class="ruby-value">:AccessLog</span>] = [
[ <span class="ruby-identifier">$stderr</span>, <span class="ruby-constant">AccessLog</span><span class="ruby-operator">::</span><span class="ruby-constant">COMMON_LOG_FORMAT</span> ],
[ <span class="ruby-identifier">$stderr</span>, <span class="ruby-constant">AccessLog</span><span class="ruby-operator">::</span><span class="ruby-constant">REFERER_LOG_FORMAT</span> ]
]
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@virtual_hosts</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</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-access_log" class="method-detail ">
<div class="method-heading">
<span class="method-name">access_log</span><span
class="method-args">(config, req, res)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Logs <code>req</code> and <code>res</code> in the access logs. <code>config</code> is used for the server name.</p>
<div class="method-source-code" id="access_log-source">
<pre><span class="ruby-comment"># File lib/webrick/httpserver.rb, line 220</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">access_log</span>(<span class="ruby-identifier">config</span>, <span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-identifier">param</span> = <span class="ruby-constant">AccessLog</span><span class="ruby-operator">::</span><span class="ruby-identifier">setup_params</span>(<span class="ruby-identifier">config</span>, <span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-ivar">@config</span>[<span class="ruby-value">:AccessLog</span>].<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">logger</span>, <span class="ruby-identifier">fmt</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">logger</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">AccessLog</span><span class="ruby-operator">::</span><span class="ruby-identifier">format</span>(<span class="ruby-identifier">fmt</span><span class="ruby-string">+"\n"</span>, <span class="ruby-identifier">param</span>)
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-create_request" class="method-detail ">
<div class="method-heading">
<span class="method-name">create_request</span><span
class="method-args">(with_webrick_config)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates the <a href="HTTPRequest.html"><code>HTTPRequest</code></a> used when handling the HTTP request. Can be overridden by subclasses.</p>
<div class="method-source-code" id="create_request-source">
<pre><span class="ruby-comment"># File lib/webrick/httpserver.rb, line 230</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_request</span>(<span class="ruby-identifier">with_webrick_config</span>)
<span class="ruby-constant">HTTPRequest</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">with_webrick_config</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-create_response" class="method-detail ">
<div class="method-heading">
<span class="method-name">create_response</span><span
class="method-args">(with_webrick_config)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates the <a href="HTTPResponse.html"><code>HTTPResponse</code></a> used when handling the HTTP request. Can be overridden by subclasses.</p>
<div class="method-source-code" id="create_response-source">
<pre><span class="ruby-comment"># File lib/webrick/httpserver.rb, line 237</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">create_response</span>(<span class="ruby-identifier">with_webrick_config</span>)
<span class="ruby-constant">HTTPResponse</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">with_webrick_config</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-do_OPTIONS" class="method-detail ">
<div class="method-heading">
<span class="method-name">do_OPTIONS</span><span
class="method-args">(req, res)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>The default OPTIONS request handler says GET, HEAD, POST and OPTIONS requests are allowed.</p>
<div class="method-source-code" id="do_OPTIONS-source">
<pre><span class="ruby-comment"># File lib/webrick/httpserver.rb, line 147</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">do_OPTIONS</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-identifier">res</span>[<span class="ruby-string">"allow"</span>] = <span class="ruby-string">"GET,HEAD,POST,OPTIONS"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-lookup_server" class="method-detail ">
<div class="method-heading">
<span class="method-name">lookup_server</span><span
class="method-args">(req)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Finds the appropriate virtual host to handle <code>req</code></p>
<div class="method-source-code" id="lookup_server-source">
<pre><span class="ruby-comment"># File lib/webrick/httpserver.rb, line 207</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">lookup_server</span>(<span class="ruby-identifier">req</span>)
<span class="ruby-ivar">@virtual_hosts</span>.<span class="ruby-identifier">find</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
(<span class="ruby-identifier">s</span>[<span class="ruby-value">:BindAddress</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">addr</span>[<span class="ruby-value">3</span>] <span class="ruby-operator">==</span> <span class="ruby-identifier">s</span>[<span class="ruby-value">:BindAddress</span>]) <span class="ruby-operator">&&</span>
(<span class="ruby-identifier">s</span>[<span class="ruby-value">:Port</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">port</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">s</span>[<span class="ruby-value">:Port</span>]) <span class="ruby-operator">&&</span>
((<span class="ruby-identifier">s</span>[<span class="ruby-value">:ServerName</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">host</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">s</span>[<span class="ruby-value">:ServerName</span>]) <span class="ruby-operator">||</span>
(<span class="ruby-operator">!</span><span class="ruby-identifier">s</span>[<span class="ruby-value">:ServerAlias</span>].<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">s</span>[<span class="ruby-value">:ServerAlias</span>].<span class="ruby-identifier">find</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">h</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">host</span>}))
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mount" class="method-detail ">
<div class="method-heading">
<span class="method-name">mount</span><span
class="method-args">(dir, servlet, *options)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Mounts <code>servlet</code> on <code>dir</code> passing <code>options</code> to the servlet at creation time</p>
<div class="method-source-code" id="mount-source">
<pre><span class="ruby-comment"># File lib/webrick/httpserver.rb, line 155</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mount</span>(<span class="ruby-identifier">dir</span>, <span class="ruby-identifier">servlet</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">options</span>)
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-identifier">sprintf</span>(<span class="ruby-string">"%s is mounted on %s."</span>, <span class="ruby-identifier">servlet</span>.<span class="ruby-identifier">inspect</span>, <span class="ruby-identifier">dir</span>))
<span class="ruby-ivar">@mount_tab</span>[<span class="ruby-identifier">dir</span>] = [ <span class="ruby-identifier">servlet</span>, <span class="ruby-identifier">options</span> ]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-mount_proc" class="method-detail ">
<div class="method-heading">
<span class="method-name">mount_proc</span><span
class="method-args">(dir, proc=nil, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Mounts <code>proc</code> or <code>block</code> on <code>dir</code> and calls it with a <a href="HTTPRequest.html"><code>WEBrick::HTTPRequest</code></a> and <a href="HTTPResponse.html"><code>WEBrick::HTTPResponse</code></a></p>
<div class="method-source-code" id="mount_proc-source">
<pre><span class="ruby-comment"># File lib/webrick/httpserver.rb, line 164</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">mount_proc</span>(<span class="ruby-identifier">dir</span>, <span class="ruby-identifier">proc</span>=<span class="ruby-keyword">nil</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">proc</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">block</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPServerError</span>, <span class="ruby-string">"must pass a proc or block"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">proc</span>
<span class="ruby-identifier">mount</span>(<span class="ruby-identifier">dir</span>, <span class="ruby-constant">HTTPServlet</span><span class="ruby-operator">::</span><span class="ruby-constant">ProcHandler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">proc</span>))
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-run" class="method-detail ">
<div class="method-heading">
<span class="method-name">run</span><span
class="method-args">(sock)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Processes requests on <code>sock</code></p>
<div class="method-source-code" id="run-source">
<pre><span class="ruby-comment"># File lib/webrick/httpserver.rb, line 69</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">run</span>(<span class="ruby-identifier">sock</span>)
<span class="ruby-keyword">while</span> <span class="ruby-keyword">true</span>
<span class="ruby-identifier">req</span> = <span class="ruby-identifier">create_request</span>(<span class="ruby-ivar">@config</span>)
<span class="ruby-identifier">res</span> = <span class="ruby-identifier">create_response</span>(<span class="ruby-ivar">@config</span>)
<span class="ruby-identifier">server</span> = <span class="ruby-keyword">self</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">timeout</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-value">:RequestTimeout</span>]
<span class="ruby-keyword">while</span> <span class="ruby-identifier">timeout</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
<span class="ruby-keyword">break</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">to_io</span>.<span class="ruby-identifier">wait_readable</span>(<span class="ruby-value">0.5</span>)
<span class="ruby-keyword">break</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@status</span> <span class="ruby-operator">!=</span> <span class="ruby-value">:Running</span>
<span class="ruby-identifier">timeout</span> <span class="ruby-operator">-=</span> <span class="ruby-value">0.5</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">EOFError</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">timeout</span> <span class="ruby-operator"><=</span> <span class="ruby-value">0</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@status</span> <span class="ruby-operator">!=</span> <span class="ruby-value">:Running</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">EOFError</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">sock</span>.<span class="ruby-identifier">eof?</span>
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">sock</span>)
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">request_method</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">request_method</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">request_uri</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">request_uri</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">request_http_version</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">http_version</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">keep_alive</span> = <span class="ruby-identifier">req</span>.<span class="ruby-identifier">keep_alive?</span>
<span class="ruby-identifier">server</span> = <span class="ruby-identifier">lookup_server</span>(<span class="ruby-identifier">req</span>) <span class="ruby-operator">||</span> <span class="ruby-keyword">self</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">callback</span> = <span class="ruby-identifier">server</span>[<span class="ruby-value">:RequestCallback</span>]
<span class="ruby-identifier">callback</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">callback</span> = <span class="ruby-identifier">server</span>[<span class="ruby-value">:RequestHandler</span>]
<span class="ruby-identifier">msg</span> = <span class="ruby-string">":RequestHandler is deprecated, please use :RequestCallback"</span>
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-identifier">msg</span>)
<span class="ruby-identifier">callback</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">service</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">EOFError</span>, <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">RequestTimeout</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">ex</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">set_error</span>(<span class="ruby-identifier">ex</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">ex</span>
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">ex</span>.<span class="ruby-identifier">message</span>)
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">set_error</span>(<span class="ruby-identifier">ex</span>)
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">Status</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">ex</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">status</span> = <span class="ruby-identifier">ex</span>.<span class="ruby-identifier">code</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">StandardError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">ex</span>
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">ex</span>)
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">set_error</span>(<span class="ruby-identifier">ex</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-keyword">ensure</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">request_line</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">keep_alive?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">keep_alive?</span>
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">fixup</span>()
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">res</span>.<span class="ruby-identifier">send_response</span>(<span class="ruby-identifier">sock</span>)
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">access_log</span>(<span class="ruby-ivar">@config</span>, <span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">break</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@http_version</span> <span class="ruby-operator"><</span> <span class="ruby-string">"1.1"</span>
<span class="ruby-keyword">break</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">keep_alive?</span>
<span class="ruby-keyword">break</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">keep_alive?</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-search_servlet" class="method-detail ">
<div class="method-heading">
<span class="method-name">search_servlet</span><span
class="method-args">(path)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Finds a servlet for <code>path</code></p>
<div class="method-source-code" id="search_servlet-source">
<pre><span class="ruby-comment"># File lib/webrick/httpserver.rb, line 182</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">search_servlet</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-identifier">script_name</span>, <span class="ruby-identifier">path_info</span> = <span class="ruby-ivar">@mount_tab</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-identifier">servlet</span>, <span class="ruby-identifier">options</span> = <span class="ruby-ivar">@mount_tab</span>[<span class="ruby-identifier">script_name</span>]
<span class="ruby-keyword">if</span> <span class="ruby-identifier">servlet</span>
[ <span class="ruby-identifier">servlet</span>, <span class="ruby-identifier">options</span>, <span class="ruby-identifier">script_name</span>, <span class="ruby-identifier">path_info</span> ]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<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">
<p>Services <code>req</code> and fills in <code>res</code></p>
<div class="method-source-code" id="service-source">
<pre><span class="ruby-comment"># File lib/webrick/httpserver.rb, line 125</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-keyword">if</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">unparsed_uri</span> <span class="ruby-operator">==</span> <span class="ruby-string">"*"</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">req</span>.<span class="ruby-identifier">request_method</span> <span class="ruby-operator">==</span> <span class="ruby-string">"OPTIONS"</span>
<span class="ruby-identifier">do_OPTIONS</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">OK</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">NotFound</span>, <span class="ruby-node">"`#{req.unparsed_uri}' not found."</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">servlet</span>, <span class="ruby-identifier">options</span>, <span class="ruby-identifier">script_name</span>, <span class="ruby-identifier">path_info</span> = <span class="ruby-identifier">search_servlet</span>(<span class="ruby-identifier">req</span>.<span class="ruby-identifier">path</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">HTTPStatus</span><span class="ruby-operator">::</span><span class="ruby-constant">NotFound</span>, <span class="ruby-node">"`#{req.path}' not found."</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">servlet</span>
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">script_name</span> = <span class="ruby-identifier">script_name</span>
<span class="ruby-identifier">req</span>.<span class="ruby-identifier">path_info</span> = <span class="ruby-identifier">path_info</span>
<span class="ruby-identifier">si</span> = <span class="ruby-identifier">servlet</span>.<span class="ruby-identifier">get_instance</span>(<span class="ruby-keyword">self</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">options</span>)
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-identifier">format</span>(<span class="ruby-string">"%s is invoked."</span>, <span class="ruby-identifier">si</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>))
<span class="ruby-identifier">si</span>.<span class="ruby-identifier">service</span>(<span class="ruby-identifier">req</span>, <span class="ruby-identifier">res</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ssl_servername_callback" class="method-detail ">
<div class="method-heading">
<span class="method-name">ssl_servername_callback</span><span
class="method-args">(sslsocket, hostname = nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>ServerNameIndication callback</p>
<div class="method-source-code" id="ssl_servername_callback-source">
<pre><span class="ruby-comment"># File lib/webrick/https.rb, line 129</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ssl_servername_callback</span>(<span class="ruby-identifier">sslsocket</span>, <span class="ruby-identifier">hostname</span> = <span class="ruby-keyword">nil</span>)
<span class="ruby-identifier">req</span> = <span class="ruby-constant">SNIRequest</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">sslsocket</span>, <span class="ruby-identifier">hostname</span>)
<span class="ruby-identifier">server</span> = <span class="ruby-identifier">lookup_server</span>(<span class="ruby-identifier">req</span>)
<span class="ruby-identifier">server</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">server</span>.<span class="ruby-identifier">ssl_context</span> <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-umount" class="method-detail method-alias">
<div class="method-heading">
<span class="method-name">umount</span><span
class="method-args">(dir)</span>
</div>
<div class="method-description">
</div>
<div class="aliases">
Alias for: <a href="HTTPServer.html#method-i-unmount">unmount</a>
</div>
</div>
<div id="method-i-unmount" class="method-detail ">
<div class="method-heading">
<span class="method-name">unmount</span><span
class="method-args">(dir)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Unmounts <code>dir</code></p>
<div class="method-source-code" id="unmount-source">
<pre><span class="ruby-comment"># File lib/webrick/httpserver.rb, line 173</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unmount</span>(<span class="ruby-identifier">dir</span>)
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-identifier">sprintf</span>(<span class="ruby-string">"unmount %s."</span>, <span class="ruby-identifier">dir</span>))
<span class="ruby-ivar">@mount_tab</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">dir</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
<div class="aliases">
Also aliased as: <a href="HTTPServer.html#method-i-umount">umount</a>
</div>
</div>
<div id="method-i-virtual_host" class="method-detail ">
<div class="method-heading">
<span class="method-name">virtual_host</span><span
class="method-args">(server)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds <code>server</code> as a virtual host.</p>
<div class="method-source-code" id="virtual_host-source">
<pre><span class="ruby-comment"># File lib/webrick/httpserver.rb, line 193</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">virtual_host</span>(<span class="ruby-identifier">server</span>)
<span class="ruby-ivar">@virtual_hosts</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">server</span>
<span class="ruby-ivar">@virtual_hosts</span> = <span class="ruby-ivar">@virtual_hosts</span>.<span class="ruby-identifier">sort_by</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">num</span> = <span class="ruby-value">0</span>
<span class="ruby-identifier">num</span> <span class="ruby-operator">-=</span> <span class="ruby-value">4</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">s</span>[<span class="ruby-value">:BindAddress</span>]
<span class="ruby-identifier">num</span> <span class="ruby-operator">-=</span> <span class="ruby-value">2</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">s</span>[<span class="ruby-value">:Port</span>]
<span class="ruby-identifier">num</span> <span class="ruby-operator">-=</span> <span class="ruby-value">1</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">s</span>[<span class="ruby-value">:ServerName</span>]
<span class="ruby-identifier">num</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>