doc/rdoc/classes/Mongrel/Configurator.html in mongrel-0.3.13.3 vs doc/rdoc/classes/Mongrel/Configurator.html in mongrel-0.3.13.4
- old
+ new
@@ -53,12 +53,12 @@
<td class="class-name-in-header">Mongrel::Configurator</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
- <a href="../../files/lib/mongrel_rb.html">
- lib/mongrel.rb
+ <a href="../../files/lib/mongrel/configurator_rb.html">
+ lib/mongrel/configurator.rb
</a>
<br />
</td>
</tr>
@@ -104,11 +104,11 @@
=> "127.0.0.1" is actually not specific to the servers but
just a hash of default parameters that all server or uri calls receive.
</p>
<p>
When you are inside the block after <a
-href="Configurator.html#M000110">Mongrel::Configurator.new</a> you can
+href="Configurator.html#M000091">Mongrel::Configurator.new</a> you can
simply call functions that are part of <a
href="Configurator.html">Configurator</a> (like server, uri, daemonize,
etc) without having to refer to anything else. You can also call these
functions on the resulting object directly for additional configuration.
</p>
@@ -130,31 +130,31 @@
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
- <a href="#M000111">change_privilege</a>
- <a href="#M000114">cloaker</a>
- <a href="#M000113">cloaking_class</a>
- <a href="#M000118">daemonize</a>
- <a href="#M000127">debug</a>
- <a href="#M000126">join</a>
- <a href="#M000116">listener</a>
- <a href="#M000121">load_mime_map</a>
- <a href="#M000119">load_plugins</a>
- <a href="#M000120">load_yaml</a>
- <a href="#M000130">log</a>
- <a href="#M000110">new</a>
- <a href="#M000122">plugin</a>
- <a href="#M000123">redirect</a>
- <a href="#M000115">resolve_defaults</a>
- <a href="#M000124">run</a>
- <a href="#M000128">run_config</a>
- <a href="#M000129">setup_signals</a>
- <a href="#M000125">stop</a>
- <a href="#M000117">uri</a>
- <a href="#M000112">write_pid_file</a>
+ <a href="#M000092">change_privilege</a>
+ <a href="#M000095">cloaker</a>
+ <a href="#M000094">cloaking_class</a>
+ <a href="#M000099">daemonize</a>
+ <a href="#M000108">debug</a>
+ <a href="#M000107">join</a>
+ <a href="#M000097">listener</a>
+ <a href="#M000102">load_mime_map</a>
+ <a href="#M000100">load_plugins</a>
+ <a href="#M000101">load_yaml</a>
+ <a href="#M000111">log</a>
+ <a href="#M000091">new</a>
+ <a href="#M000103">plugin</a>
+ <a href="#M000104">redirect</a>
+ <a href="#M000096">resolve_defaults</a>
+ <a href="#M000105">run</a>
+ <a href="#M000109">run_config</a>
+ <a href="#M000110">setup_signals</a>
+ <a href="#M000106">stop</a>
+ <a href="#M000098">uri</a>
+ <a href="#M000093">write_pid_file</a>
</div>
</div>
</div>
@@ -195,16 +195,16 @@
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
- <div id="method-M000110" class="method-detail">
- <a name="M000110"></a>
+ <div id="method-M000091" class="method-detail">
+ <a name="M000091"></a>
<div class="method-heading">
- <a href="Configurator.src/M000110.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000110.html');return false;">
+ <a href="Configurator.src/M000091.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000091.html');return false;">
<span class="method-name">new</span><span class="method-args">(defaults={}, &blk)</span>
</a>
</div>
<div class="method-description">
@@ -214,16 +214,16 @@
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
- <div id="method-M000111" class="method-detail">
- <a name="M000111"></a>
+ <div id="method-M000092" class="method-detail">
+ <a name="M000092"></a>
<div class="method-heading">
- <a href="Configurator.src/M000111.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000111.html');return false;">
+ <a href="Configurator.src/M000092.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000092.html');return false;">
<span class="method-name">change_privilege</span><span class="method-args">(user, group)</span>
</a>
</div>
<div class="method-description">
@@ -231,16 +231,16 @@
Change privilege of the process to specified user and group.
</p>
</div>
</div>
- <div id="method-M000114" class="method-detail">
- <a name="M000114"></a>
+ <div id="method-M000095" class="method-detail">
+ <a name="M000095"></a>
<div class="method-heading">
- <a href="Configurator.src/M000114.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000114.html');return false;">
+ <a href="Configurator.src/M000095.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000095.html');return false;">
<span class="method-name">cloaker</span><span class="method-args">(&blk)</span>
</a>
</div>
<div class="method-description">
@@ -248,16 +248,16 @@
Do not call this. You were warned.
</p>
</div>
</div>
- <div id="method-M000113" class="method-detail">
- <a name="M000113"></a>
+ <div id="method-M000094" class="method-detail">
+ <a name="M000094"></a>
<div class="method-heading">
- <a href="Configurator.src/M000113.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000113.html');return false;">
+ <a href="Configurator.src/M000094.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000094.html');return false;">
<span class="method-name">cloaking_class</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
@@ -265,16 +265,16 @@
generates a class for cloaking the current self and making the DSL nicer
</p>
</div>
</div>
- <div id="method-M000118" class="method-detail">
- <a name="M000118"></a>
+ <div id="method-M000099" class="method-detail">
+ <a name="M000099"></a>
<div class="method-heading">
- <a href="Configurator.src/M000118.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000118.html');return false;">
+ <a href="Configurator.src/M000099.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000099.html');return false;">
<span class="method-name">daemonize</span><span class="method-args">(options={})</span>
</a>
</div>
<div class="method-description">
@@ -303,16 +303,16 @@
gem/library if NOT win32.
</p>
</div>
</div>
- <div id="method-M000127" class="method-detail">
- <a name="M000127"></a>
+ <div id="method-M000108" class="method-detail">
+ <a name="M000108"></a>
<div class="method-heading">
- <a href="Configurator.src/M000127.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000127.html');return false;">
+ <a href="Configurator.src/M000108.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000108.html');return false;">
<span class="method-name">debug</span><span class="method-args">(location, what = [:objects, :rails, :files, :threads, :params])</span>
</a>
</div>
<div class="method-description">
@@ -338,16 +338,16 @@
NOTE: Use [:files] to get accesses dumped to stderr like with WEBrick.
</p>
</div>
</div>
- <div id="method-M000126" class="method-detail">
- <a name="M000126"></a>
+ <div id="method-M000107" class="method-detail">
+ <a name="M000107"></a>
<div class="method-heading">
- <a href="Configurator.src/M000126.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000126.html');return false;">
+ <a href="Configurator.src/M000107.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000107.html');return false;">
<span class="method-name">join</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
@@ -357,27 +357,27 @@
In other words do it like: config.join.
</p>
</div>
</div>
- <div id="method-M000116" class="method-detail">
- <a name="M000116"></a>
+ <div id="method-M000097" class="method-detail">
+ <a name="M000097"></a>
<div class="method-heading">
- <a href="Configurator.src/M000116.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000116.html');return false;">
+ <a href="Configurator.src/M000097.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000097.html');return false;">
<span class="method-name">listener</span><span class="method-args">(options={},&blk)</span>
</a>
</div>
<div class="method-description">
<p>
Starts a listener block. This is the only one that actually takes a block
-and then you make <a href="Configurator.html#M000117">Configurator.uri</a>
+and then you make <a href="Configurator.html#M000098">Configurator.uri</a>
calls in order to setup your URIs and handlers. If you write your Handlers
as GemPlugins then you can use <a
-href="Configurator.html#M000119">load_plugins</a> and plugin to load them.
+href="Configurator.html#M000100">load_plugins</a> and plugin to load them.
</p>
<p>
It expects the following options (or defaults):
</p>
<ul>
@@ -403,16 +403,16 @@
</li>
</ul>
</div>
</div>
- <div id="method-M000121" class="method-detail">
- <a name="M000121"></a>
+ <div id="method-M000102" class="method-detail">
+ <a name="M000102"></a>
<div class="method-heading">
- <a href="Configurator.src/M000121.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000121.html');return false;">
+ <a href="Configurator.src/M000102.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000102.html');return false;">
<span class="method-name">load_mime_map</span><span class="method-args">(file, mime={})</span>
</a>
</div>
<div class="method-description">
@@ -425,16 +425,16 @@
MIME types map is organized.
</p>
</div>
</div>
- <div id="method-M000119" class="method-detail">
- <a name="M000119"></a>
+ <div id="method-M000100" class="method-detail">
+ <a name="M000100"></a>
<div class="method-heading">
- <a href="Configurator.src/M000119.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000119.html');return false;">
+ <a href="Configurator.src/M000100.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000100.html');return false;">
<span class="method-name">load_plugins</span><span class="method-args">(options={})</span>
</a>
</div>
<div class="method-description">
@@ -445,16 +445,16 @@
determining the dependencies.
</p>
</div>
</div>
- <div id="method-M000120" class="method-detail">
- <a name="M000120"></a>
+ <div id="method-M000101" class="method-detail">
+ <a name="M000101"></a>
<div class="method-heading">
- <a href="Configurator.src/M000120.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000120.html');return false;">
+ <a href="Configurator.src/M000101.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000101.html');return false;">
<span class="method-name">load_yaml</span><span class="method-args">(file, default={})</span>
</a>
</div>
<div class="method-description">
@@ -462,16 +462,16 @@
Easy way to load a YAML file and apply default settings.
</p>
</div>
</div>
- <div id="method-M000130" class="method-detail">
- <a name="M000130"></a>
+ <div id="method-M000111" class="method-detail">
+ <a name="M000111"></a>
<div class="method-heading">
- <a href="Configurator.src/M000130.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000130.html');return false;">
+ <a href="Configurator.src/M000111.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000111.html');return false;">
<span class="method-name">log</span><span class="method-args">(msg)</span>
</a>
</div>
<div class="method-description">
@@ -479,16 +479,16 @@
Logs a simple message to STDERR (or the mongrel log if in daemon mode).
</p>
</div>
</div>
- <div id="method-M000122" class="method-detail">
- <a name="M000122"></a>
+ <div id="method-M000103" class="method-detail">
+ <a name="M000103"></a>
<div class="method-heading">
- <a href="Configurator.src/M000122.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000122.html');return false;">
+ <a href="Configurator.src/M000103.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000103.html');return false;">
<span class="method-name">plugin</span><span class="method-args">(name, options={})</span>
</a>
</div>
<div class="method-description">
@@ -498,16 +498,16 @@
to passing them in.
</p>
</div>
</div>
- <div id="method-M000123" class="method-detail">
- <a name="M000123"></a>
+ <div id="method-M000104" class="method-detail">
+ <a name="M000104"></a>
<div class="method-heading">
- <a href="Configurator.src/M000123.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000123.html');return false;">
+ <a href="Configurator.src/M000104.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000104.html');return false;">
<span class="method-name">redirect</span><span class="method-args">(from, pattern, replacement = nil, &block)</span>
</a>
</div>
<div class="method-description">
@@ -522,16 +522,16 @@
redirect("/hey", /(w+)/) {|match| ...} # block
</pre>
</div>
</div>
- <div id="method-M000115" class="method-detail">
- <a name="M000115"></a>
+ <div id="method-M000096" class="method-detail">
+ <a name="M000096"></a>
<div class="method-heading">
- <a href="Configurator.src/M000115.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000115.html');return false;">
+ <a href="Configurator.src/M000096.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000096.html');return false;">
<span class="method-name">resolve_defaults</span><span class="method-args">(options)</span>
</a>
</div>
<div class="method-description">
@@ -540,36 +540,36 @@
used internally.
</p>
</div>
</div>
- <div id="method-M000124" class="method-detail">
- <a name="M000124"></a>
+ <div id="method-M000105" class="method-detail">
+ <a name="M000105"></a>
<div class="method-heading">
- <a href="Configurator.src/M000124.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000124.html');return false;">
+ <a href="Configurator.src/M000105.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000105.html');return false;">
<span class="method-name">run</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Works like a meta run method which goes through all the configured
listeners. Use the <a
-href="Configurator.html#M000126">Configurator.join</a> method to prevent
+href="Configurator.html#M000107">Configurator.join</a> method to prevent
Ruby from exiting until each one is done.
</p>
</div>
</div>
- <div id="method-M000128" class="method-detail">
- <a name="M000128"></a>
+ <div id="method-M000109" class="method-detail">
+ <a name="M000109"></a>
<div class="method-heading">
- <a href="Configurator.src/M000128.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000128.html');return false;">
+ <a href="Configurator.src/M000109.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000109.html');return false;">
<span class="method-name">run_config</span><span class="method-args">(script)</span>
</a>
</div>
<div class="method-description">
@@ -581,16 +581,16 @@
href="Configurator.html">Configurator</a> statements.
</p>
</div>
</div>
- <div id="method-M000129" class="method-detail">
- <a name="M000129"></a>
+ <div id="method-M000110" class="method-detail">
+ <a name="M000110"></a>
<div class="method-heading">
- <a href="Configurator.src/M000129.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000129.html');return false;">
+ <a href="Configurator.src/M000110.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000110.html');return false;">
<span class="method-name">setup_signals</span><span class="method-args">(options={})</span>
</a>
</div>
<div class="method-description">
@@ -599,54 +599,54 @@
configures if the platform is not win32 and doesn’t do a HUP signal
since this is typically framework specific.
</p>
<p>
Requires a :pid_file option given to <a
-href="Configurator.html#M000110">Configurator.new</a> to indicate a file to
+href="Configurator.html#M000091">Configurator.new</a> to indicate a file to
delete. It sets the MongrelConfig.needs_restart attribute if the start
command should reload. It’s up to you to detect this and do whatever
is needed for a "restart".
</p>
<p>
This command is safely ignored if the platform is win32 (with a warning)
</p>
</div>
</div>
- <div id="method-M000125" class="method-detail">
- <a name="M000125"></a>
+ <div id="method-M000106" class="method-detail">
+ <a name="M000106"></a>
<div class="method-heading">
- <a href="Configurator.src/M000125.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000125.html');return false;">
- <span class="method-name">stop</span><span class="method-args">(needs_restart=false, unlink_pid_file=true)</span>
+ <a href="Configurator.src/M000106.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000106.html');return false;">
+ <span class="method-name">stop</span><span class="method-args">(needs_restart=false)</span>
</a>
</div>
<div class="method-description">
<p>
Calls .stop on all the configured listeners so they stop processing
requests (gracefully). By default it assumes that you don’t want to
-restart and that the pid file should be unlinked on exit.
+restart.
</p>
</div>
</div>
- <div id="method-M000117" class="method-detail">
- <a name="M000117"></a>
+ <div id="method-M000098" class="method-detail">
+ <a name="M000098"></a>
<div class="method-heading">
- <a href="Configurator.src/M000117.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000117.html');return false;">
+ <a href="Configurator.src/M000098.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000098.html');return false;">
<span class="method-name">uri</span><span class="method-args">(location, options={})</span>
</a>
</div>
<div class="method-description">
<p>
Called inside a <a
-href="Configurator.html#M000116">Configurator.listener</a> block in order
+href="Configurator.html#M000097">Configurator.listener</a> block in order
to add URI->handler mappings for that listener. Use this as many times
as you like. It expects the following options or defaults:
</p>
<ul>
<li>:handler => <a href="HttpHandler.html">HttpHandler</a> — Handler
@@ -659,15 +659,15 @@
</li>
</ul>
</div>
</div>
- <div id="method-M000112" class="method-detail">
- <a name="M000112"></a>
+ <div id="method-M000093" class="method-detail">
+ <a name="M000093"></a>
<div class="method-heading">
- <a href="Configurator.src/M000112.html" target="Code" class="method-signature"
- onclick="popupCode('Configurator.src/M000112.html');return false;">
+ <a href="Configurator.src/M000093.html" target="Code" class="method-signature"
+ onclick="popupCode('Configurator.src/M000093.html');return false;">
<span class="method-name">write_pid_file</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
\ No newline at end of file