Mini Shell
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: Rack::Server</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">Rack::Server</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../files/lib/rack/server_rb.html">
lib/rack/server.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000420">app</a>
<a href="#M000422">default_middleware_by_environment</a>
<a href="#M000419">default_options</a>
<a href="#M000421">logging_middleware</a>
<a href="#M000423">middleware</a>
<a href="#M000424">middleware</a>
<a href="#M000417">new</a>
<a href="#M000418">options</a>
<a href="#M000426">server</a>
<a href="#M000425">start</a>
<a href="#M000416">start</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="class-list">
<h3 class="section-bar">Classes and Modules</h3>
Class <a href="Server/Options.html" class="link">Rack::Server::Options</a><br />
</div>
<div id="attribute-list">
<h3 class="section-bar">Attributes</h3>
<div class="name-list">
<table>
<tr class="top-aligned-row context-row">
<td class="context-item-name">options</td>
<td class="context-item-value"> [W] </td>
<td class="context-item-desc"></td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000422" class="method-detail">
<a name="M000422"></a>
<div class="method-heading">
<a href="Server.src/M000422.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000422.html');return false;">
<span class="method-name">default_middleware_by_environment</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000421" class="method-detail">
<a name="M000421"></a>
<div class="method-heading">
<a href="Server.src/M000421.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000421.html');return false;">
<span class="method-name">logging_middleware</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000423" class="method-detail">
<a name="M000423"></a>
<div class="method-heading">
<a href="Server.src/M000423.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000423.html');return false;">
<span class="method-name">middleware</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000417" class="method-detail">
<a name="M000417"></a>
<div class="method-heading">
<a href="Server.src/M000417.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000417.html');return false;">
<span class="method-name">new</span><span class="method-args">(options = nil)</span>
</a>
</div>
<div class="method-description">
<p>
<a href="Server/Options.html">Options</a> may include:
</p>
<ul>
<li>:<a href="Server.html#M000420">app</a>
<pre>
a rack application to run (overrides :config)
</pre>
</li>
<li>:config
<pre>
a rackup configuration file path to load (.ru)
</pre>
</li>
<li>:environment
<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>:<a href="Server.html#M000426">server</a>
<pre>
choose a specific Rack::Handler, e.g. cgi, fcgi, webrick
</pre>
</li>
<li>:daemonize
<pre>
if true, the server will daemonize itself (fork, detach, etc)
</pre>
</li>
<li>:pid
<pre>
path to write a pid file after daemonize
</pre>
</li>
<li>:Host
<pre>
the host address to bind to (used by supporting Rack::Handler)
</pre>
</li>
<li>:Port
<pre>
the port to bind to (used by supporting Rack::Handler)
</pre>
</li>
<li>:AccessLog
<pre>
webrick access log options (or supporting Rack::Handler)
</pre>
</li>
<li>:debug
<pre>
turn on debug output ($DEBUG = true)
</pre>
</li>
<li>:warn
<pre>
turn on warnings ($-w = true)
</pre>
</li>
<li>:include
<pre>
add given paths to $LOAD_PATH
</pre>
</li>
<li>:require
<pre>
require the given libraries
</pre>
</li>
</ul>
</div>
</div>
<div id="method-M000416" class="method-detail">
<a name="M000416"></a>
<div class="method-heading">
<a href="Server.src/M000416.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000416.html');return false;">
<span class="method-name">start</span><span class="method-args">(options = nil)</span>
</a>
</div>
<div class="method-description">
<p>
Start a <a href="Server.html#M000417">new</a> rack <a
href="Server.html#M000426">server</a> (like running rackup). This will
parse ARGV and provide standard ARGV rackup <a
href="Server.html#M000418">options</a>, defaulting to load
‘config.ru’.
</p>
<p>
Providing an <a href="Server.html#M000418">options</a> hash will prevent
ARGV parsing and will not include any default <a
href="Server.html#M000418">options</a>.
</p>
<p>
This method can be used to very easily launch a CGI application, for
example:
</p>
<pre>
Rack::Server.start(
:app => lambda do |e|
[200, {'Content-Type' => 'text/html'}, ['hello world']]
end,
:server => 'cgi'
)
</pre>
<p>
Further <a href="Server.html#M000418">options</a> available here are
documented on Rack::Server#initialize
</p>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000420" class="method-detail">
<a name="M000420"></a>
<div class="method-heading">
<a href="Server.src/M000420.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000420.html');return false;">
<span class="method-name">app</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000419" class="method-detail">
<a name="M000419"></a>
<div class="method-heading">
<a href="Server.src/M000419.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000419.html');return false;">
<span class="method-name">default_options</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000424" class="method-detail">
<a name="M000424"></a>
<div class="method-heading">
<a href="Server.src/M000424.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000424.html');return false;">
<span class="method-name">middleware</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000418" class="method-detail">
<a name="M000418"></a>
<div class="method-heading">
<a href="Server.src/M000418.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000418.html');return false;">
<span class="method-name">options</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000426" class="method-detail">
<a name="M000426"></a>
<div class="method-heading">
<a href="Server.src/M000426.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000426.html');return false;">
<span class="method-name">server</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000425" class="method-detail">
<a name="M000425"></a>
<div class="method-heading">
<a href="Server.src/M000425.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000425.html');return false;">
<span class="method-name">start</span><span class="method-args">(&blk)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
Zerion Mini Shell 1.0