File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/GenericServer.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class WEBrick::GenericServer - 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="../Object.html">Object</a>
</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-new">::new</a>
<li ><a href="#method-i-5B-5D">#[]</a>
<li ><a href="#method-i-listen">#listen</a>
<li ><a href="#method-i-run">#run</a>
<li ><a href="#method-i-shutdown">#shutdown</a>
<li ><a href="#method-i-ssl_servername_callback">#ssl_servername_callback</a>
<li ><a href="#method-i-start">#start</a>
<li ><a href="#method-i-stop">#stop</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-WEBrick::GenericServer">
<h1 id="class-WEBrick::GenericServer" class="class">
class WEBrick::GenericServer
</h1>
<section class="description">
<p>Base TCP server class. You must subclass <a href="GenericServer.html"><code>GenericServer</code></a> and provide a <a href="GenericServer.html#method-i-run"><code>run</code></a> method.</p>
</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-config" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">config</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The server configuration</p>
</div>
</div>
<div id="attribute-i-listeners" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">listeners</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Sockets listening for connections.</p>
</div>
</div>
<div id="attribute-i-logger" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">logger</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The server logger. This is independent from the HTTP access log.</p>
</div>
</div>
<div id="attribute-i-status" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">status</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The server status. One of :Stop, :Running or :Shutdown</p>
</div>
</div>
<div id="attribute-i-tokens" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">tokens</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>Tokens control the number of outstanding clients. The <code>:MaxClients</code> configuration sets this.</p>
</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-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(config={}, default=Config::General)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new generic server from <code>config</code>. The default configuration comes from <code>default</code>.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/webrick/server.rb, line 88</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">General</span>)
<span class="ruby-ivar">@config</span> = <span class="ruby-identifier">default</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">config</span>)
<span class="ruby-ivar">@status</span> = <span class="ruby-value">:Stop</span>
<span class="ruby-ivar">@config</span>[<span class="ruby-value">:Logger</span>] <span class="ruby-operator">||=</span> <span class="ruby-constant">Log</span><span class="ruby-operator">::</span><span class="ruby-identifier">new</span>
<span class="ruby-ivar">@logger</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-value">:Logger</span>]
<span class="ruby-ivar">@tokens</span> = <span class="ruby-constant">Thread</span><span class="ruby-operator">::</span><span class="ruby-constant">SizedQueue</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@config</span>[<span class="ruby-value">:MaxClients</span>])
<span class="ruby-ivar">@config</span>[<span class="ruby-value">:MaxClients</span>].<span class="ruby-identifier">times</span>{ <span class="ruby-ivar">@tokens</span>.<span class="ruby-identifier">push</span>(<span class="ruby-keyword">nil</span>) }
<span class="ruby-identifier">webrickv</span> = <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>
<span class="ruby-identifier">rubyv</span> = <span class="ruby-node">"#{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"</span>
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">"WEBrick #{webrickv}"</span>)
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">info</span>(<span class="ruby-node">"ruby #{rubyv}"</span>)
<span class="ruby-ivar">@listeners</span> = []
<span class="ruby-ivar">@shutdown_pipe</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@config</span>[<span class="ruby-value">:DoNotListen</span>]
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-value">:Listen</span>]
<span class="ruby-identifier">warn</span>(<span class="ruby-string">":Listen option is deprecated; use GenericServer#listen"</span>, <span class="ruby-value">uplevel:</span> <span class="ruby-value">1</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">listen</span>(<span class="ruby-ivar">@config</span>[<span class="ruby-value">:BindAddress</span>], <span class="ruby-ivar">@config</span>[<span class="ruby-value">:Port</span>])
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-value">:Port</span>] <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
<span class="ruby-ivar">@config</span>[<span class="ruby-value">:Port</span>] = <span class="ruby-ivar">@listeners</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">addr</span>[<span class="ruby-value">1</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</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-5B-5D" class="method-detail ">
<div class="method-heading">
<span class="method-name">[]</span><span
class="method-args">(key)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Retrieves <code>key</code> from the configuration</p>
<div class="method-source-code" id="5B-5D-source">
<pre><span class="ruby-comment"># File lib/webrick/server.rb, line 118</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">[]</span>(<span class="ruby-identifier">key</span>)
<span class="ruby-ivar">@config</span>[<span class="ruby-identifier">key</span>]
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-listen" class="method-detail ">
<div class="method-heading">
<span class="method-name">listen</span><span
class="method-args">(address, port)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Adds listeners from <code>address</code> and <code>port</code> to the server. See <a href="Utils.html#method-c-create_listeners"><code>WEBrick::Utils::create_listeners</code></a> for details.</p>
<div class="method-source-code" id="listen-source">
<pre><span class="ruby-comment"># File lib/webrick/server.rb, line 126</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">listen</span>(<span class="ruby-identifier">address</span>, <span class="ruby-identifier">port</span>)
<span class="ruby-ivar">@listeners</span> <span class="ruby-operator">+=</span> <span class="ruby-constant">Utils</span><span class="ruby-operator">::</span><span class="ruby-identifier">create_listeners</span>(<span class="ruby-identifier">address</span>, <span class="ruby-identifier">port</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>You must subclass <a href="GenericServer.html"><code>GenericServer</code></a> and implement #run which accepts a TCP client socket</p>
<div class="method-source-code" id="run-source">
<pre><span class="ruby-comment"># File lib/webrick/server.rb, line 241</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">run</span>(<span class="ruby-identifier">sock</span>)
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">fatal</span> <span class="ruby-string">"run() must be provided by user."</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-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">
<p>Shuts down the server and all listening sockets. New listeners must be provided to restart the server.</p>
<div class="method-source-code" id="shutdown-source">
<pre><span class="ruby-comment"># File lib/webrick/server.rb, line 231</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">shutdown</span>
<span class="ruby-identifier">stop</span>
<span class="ruby-identifier">alarm_shutdown_pipe</span>(<span class="ruby-operator">&</span><span class="ruby-value">:close</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/ssl.rb, line 210</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-comment"># default</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">
<p>Starts the server and runs the <code>block</code> for each connection. This method does not return until the server is stopped from a signal handler or another thread using <a href="GenericServer.html#method-i-stop"><code>stop</code></a> or <a href="GenericServer.html#method-i-shutdown"><code>shutdown</code></a>.</p>
<p>If the block raises a subclass of <a href="../StandardError.html"><code>StandardError</code></a> the exception is logged and ignored. If an <a href="../IOError.html"><code>IOError</code></a> or Errno::EBADF exception is raised the exception is ignored. If an <a href="../Exception.html"><code>Exception</code></a> subclass is raised the exception is logged and re-raised which stops the server.</p>
<p>To completely shut down a server call <a href="GenericServer.html#method-i-shutdown"><code>shutdown</code></a> from ensure:</p>
<pre class="ruby"><span class="ruby-identifier">server</span> = <span class="ruby-constant">WEBrick</span><span class="ruby-operator">::</span><span class="ruby-constant">GenericServer</span>.<span class="ruby-identifier">new</span>
<span class="ruby-comment"># or WEBrick::HTTPServer.new</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">start</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-identifier">server</span>.<span class="ruby-identifier">shutdown</span>
<span class="ruby-keyword">end</span>
</pre>
<div class="method-source-code" id="start-source">
<pre><span class="ruby-comment"># File lib/webrick/server.rb, line 151</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-identifier">raise</span> <span class="ruby-constant">ServerError</span>, <span class="ruby-string">"already started."</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@status</span> <span class="ruby-operator">!=</span> <span class="ruby-value">:Stop</span>
<span class="ruby-identifier">server_type</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-value">:ServerType</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">SimpleServer</span>
<span class="ruby-identifier">setup_shutdown_pipe</span>
<span class="ruby-identifier">server_type</span>.<span class="ruby-identifier">start</span>{
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">info</span> \
<span class="ruby-node">"#{self.class}#start: pid=#{$$} port=#{@config[:Port]}"</span>
<span class="ruby-ivar">@status</span> = <span class="ruby-value">:Running</span>
<span class="ruby-identifier">call_callback</span>(<span class="ruby-value">:StartCallback</span>)
<span class="ruby-identifier">shutdown_pipe</span> = <span class="ruby-ivar">@shutdown_pipe</span>
<span class="ruby-identifier">thgroup</span> = <span class="ruby-constant">ThreadGroup</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-keyword">while</span> <span class="ruby-ivar">@status</span> <span class="ruby-operator">==</span> <span class="ruby-value">:Running</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">sp</span> = <span class="ruby-identifier">shutdown_pipe</span>[<span class="ruby-value">0</span>]
<span class="ruby-keyword">if</span> <span class="ruby-identifier">svrs</span> = <span class="ruby-constant">IO</span>.<span class="ruby-identifier">select</span>([<span class="ruby-identifier">sp</span>, <span class="ruby-operator">*</span><span class="ruby-ivar">@listeners</span>])
<span class="ruby-keyword">if</span> <span class="ruby-identifier">svrs</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">include?</span> <span class="ruby-identifier">sp</span>
<span class="ruby-comment"># swallow shutdown pipe</span>
<span class="ruby-identifier">buf</span> = <span class="ruby-constant">String</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">nil</span> <span class="ruby-keyword">while</span> <span class="ruby-constant">String</span> <span class="ruby-operator">===</span>
<span class="ruby-identifier">sp</span>.<span class="ruby-identifier">read_nonblock</span>([<span class="ruby-identifier">sp</span>.<span class="ruby-identifier">nread</span>, <span class="ruby-value">8</span>].<span class="ruby-identifier">max</span>, <span class="ruby-identifier">buf</span>, <span class="ruby-value">exception:</span> <span class="ruby-keyword">false</span>)
<span class="ruby-keyword">break</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">svrs</span>[<span class="ruby-value">0</span>].<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">svr</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@tokens</span>.<span class="ruby-identifier">pop</span> <span class="ruby-comment"># blocks while no token is there.</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">sock</span> = <span class="ruby-identifier">accept_client</span>(<span class="ruby-identifier">svr</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">config</span>[<span class="ruby-value">:DoNotReverseLookup</span>].<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">sock</span>.<span class="ruby-identifier">do_not_reverse_lookup</span> = <span class="ruby-operator">!</span><span class="ruby-operator">!</span><span class="ruby-identifier">config</span>[<span class="ruby-value">:DoNotReverseLookup</span>]
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">th</span> = <span class="ruby-identifier">start_thread</span>(<span class="ruby-identifier">sock</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-identifier">th</span>[<span class="ruby-value">:WEBrickThread</span>] = <span class="ruby-keyword">true</span>
<span class="ruby-identifier">thgroup</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">th</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@tokens</span>.<span class="ruby-identifier">push</span>(<span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">end</span>
}
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EBADF</span>, <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">ENOTSOCK</span>, <span class="ruby-constant">IOError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">ex</span>
<span class="ruby-comment"># if the listening socket was closed in GenericServer#shutdown,</span>
<span class="ruby-comment"># IO::select raise it.</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-identifier">msg</span> = <span class="ruby-node">"#{ex.class}: #{ex.message}\n\t#{ex.backtrace[0]}"</span>
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">error</span> <span class="ruby-identifier">msg</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">ex</span>
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">fatal</span> <span class="ruby-identifier">ex</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-identifier">cleanup_shutdown_pipe</span>(<span class="ruby-identifier">shutdown_pipe</span>)
<span class="ruby-identifier">cleanup_listener</span>
<span class="ruby-ivar">@status</span> = <span class="ruby-value">:Shutdown</span>
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">info</span> <span class="ruby-string">"going to shutdown ..."</span>
<span class="ruby-identifier">thgroup</span>.<span class="ruby-identifier">list</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">th</span><span class="ruby-operator">|</span> <span class="ruby-identifier">th</span>.<span class="ruby-identifier">join</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">th</span>[<span class="ruby-value">:WEBrickThread</span>] }
<span class="ruby-identifier">call_callback</span>(<span class="ruby-value">:StopCallback</span>)
<span class="ruby-ivar">@logger</span>.<span class="ruby-identifier">info</span> <span class="ruby-node">"#{self.class}#start done."</span>
<span class="ruby-ivar">@status</span> = <span class="ruby-value">:Stop</span>
<span class="ruby-keyword">end</span>
}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-stop" class="method-detail ">
<div class="method-heading">
<span class="method-name">stop</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Stops the server from accepting new connections.</p>
<div class="method-source-code" id="stop-source">
<pre><span class="ruby-comment"># File lib/webrick/server.rb, line 219</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">stop</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-ivar">@status</span> = <span class="ruby-value">:Shutdown</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">alarm_shutdown_pipe</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_nonblock</span>(<span class="ruby-string">"\0"</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>