doc/rdoc/classes/Mongrel/Configurator.html in mongrel-0.3.13.1 vs doc/rdoc/classes/Mongrel/Configurator.html in mongrel-0.3.13.2

- old
+ new

@@ -104,11 +104,11 @@ =&gt; &quot;127.0.0.1&quot; 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#M000107">Mongrel::Configurator.new</a> you can +href="Configurator.html#M000110">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="#M000108">change_privilege</a>&nbsp;&nbsp; - <a href="#M000111">cloaker</a>&nbsp;&nbsp; - <a href="#M000110">cloaking_class</a>&nbsp;&nbsp; - <a href="#M000115">daemonize</a>&nbsp;&nbsp; - <a href="#M000124">debug</a>&nbsp;&nbsp; - <a href="#M000123">join</a>&nbsp;&nbsp; - <a href="#M000113">listener</a>&nbsp;&nbsp; - <a href="#M000118">load_mime_map</a>&nbsp;&nbsp; - <a href="#M000116">load_plugins</a>&nbsp;&nbsp; - <a href="#M000117">load_yaml</a>&nbsp;&nbsp; - <a href="#M000127">log</a>&nbsp;&nbsp; - <a href="#M000107">new</a>&nbsp;&nbsp; - <a href="#M000119">plugin</a>&nbsp;&nbsp; - <a href="#M000120">redirect</a>&nbsp;&nbsp; - <a href="#M000112">resolve_defaults</a>&nbsp;&nbsp; - <a href="#M000121">run</a>&nbsp;&nbsp; - <a href="#M000125">run_config</a>&nbsp;&nbsp; - <a href="#M000126">setup_signals</a>&nbsp;&nbsp; - <a href="#M000122">stop</a>&nbsp;&nbsp; - <a href="#M000114">uri</a>&nbsp;&nbsp; - <a href="#M000109">write_pid_file</a>&nbsp;&nbsp; + <a href="#M000111">change_privilege</a>&nbsp;&nbsp; + <a href="#M000114">cloaker</a>&nbsp;&nbsp; + <a href="#M000113">cloaking_class</a>&nbsp;&nbsp; + <a href="#M000118">daemonize</a>&nbsp;&nbsp; + <a href="#M000127">debug</a>&nbsp;&nbsp; + <a href="#M000126">join</a>&nbsp;&nbsp; + <a href="#M000116">listener</a>&nbsp;&nbsp; + <a href="#M000121">load_mime_map</a>&nbsp;&nbsp; + <a href="#M000119">load_plugins</a>&nbsp;&nbsp; + <a href="#M000120">load_yaml</a>&nbsp;&nbsp; + <a href="#M000130">log</a>&nbsp;&nbsp; + <a href="#M000110">new</a>&nbsp;&nbsp; + <a href="#M000122">plugin</a>&nbsp;&nbsp; + <a href="#M000123">redirect</a>&nbsp;&nbsp; + <a href="#M000115">resolve_defaults</a>&nbsp;&nbsp; + <a href="#M000124">run</a>&nbsp;&nbsp; + <a href="#M000128">run_config</a>&nbsp;&nbsp; + <a href="#M000129">setup_signals</a>&nbsp;&nbsp; + <a href="#M000125">stop</a>&nbsp;&nbsp; + <a href="#M000117">uri</a>&nbsp;&nbsp; + <a href="#M000112">write_pid_file</a>&nbsp;&nbsp; </div> </div> </div> @@ -195,16 +195,16 @@ <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Class methods</h3> - <div id="method-M000107" class="method-detail"> - <a name="M000107"></a> + <div id="method-M000110" class="method-detail"> + <a name="M000110"></a> <div class="method-heading"> - <a href="Configurator.src/M000107.html" target="Code" class="method-signature" - onclick="popupCode('Configurator.src/M000107.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">new</span><span class="method-args">(defaults={}, &amp;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-M000108" class="method-detail"> - <a name="M000108"></a> + <div id="method-M000111" class="method-detail"> + <a name="M000111"></a> <div class="method-heading"> - <a href="Configurator.src/M000108.html" target="Code" class="method-signature" - onclick="popupCode('Configurator.src/M000108.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">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-M000111" class="method-detail"> - <a name="M000111"></a> + <div id="method-M000114" class="method-detail"> + <a name="M000114"></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/M000114.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000114.html');return false;"> <span class="method-name">cloaker</span><span class="method-args">(&amp;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-M000110" class="method-detail"> - <a name="M000110"></a> + <div id="method-M000113" class="method-detail"> + <a name="M000113"></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/M000113.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000113.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-M000115" class="method-detail"> - <a name="M000115"></a> + <div id="method-M000118" class="method-detail"> + <a name="M000118"></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/M000118.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000118.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-M000124" class="method-detail"> - <a name="M000124"></a> + <div id="method-M000127" class="method-detail"> + <a name="M000127"></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/M000127.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000127.html');return false;"> <span class="method-name">debug</span><span class="method-args">(location, what = [:object, :rails, :files, :threads, :params])</span> </a> </div> <div class="method-description"> @@ -330,54 +330,54 @@ <pre> debug &quot;/&quot;, what = [:rails] </pre> <p> And it will only produce the log/mongrel_debug/rails.log file. Available -options are: :object, :railes, :files, :threads, :params +options are: :object, :rails, :files, :threads, :params </p> <p> -NOTE: Use [:files] to get acccesses dumped to stderr like with WEBrick. +NOTE: Use [:files] to get accesses dumped to stderr like with WEBrick. </p> </div> </div> - <div id="method-M000123" class="method-detail"> - <a name="M000123"></a> + <div id="method-M000126" class="method-detail"> + <a name="M000126"></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/M000126.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000126.html');return false;"> <span class="method-name">join</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> This method should actually be called <b>outside</b> of the <a href="Configurator.html">Configurator</a> block so that you can control it. -In otherwords do it like: config.join. +In other words do it like: config.join. </p> </div> </div> - <div id="method-M000113" class="method-detail"> - <a name="M000113"></a> + <div id="method-M000116" class="method-detail"> + <a name="M000116"></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/M000116.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000116.html');return false;"> <span class="method-name">listener</span><span class="method-args">(options={},&amp;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#M000114">Configurator.uri</a> +and then you make <a href="Configurator.html#M000117">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#M000116">load_plugins</a> and plugin to load them. +href="Configurator.html#M000119">load_plugins</a> and plugin to load them. </p> <p> It expects the following options (or defaults): </p> <ul> @@ -393,20 +393,26 @@ </li> <li>:timeout =&gt; 1/100th of a second timeout between requests. (10 is 1/10th, 0 is timeout) </li> +<li>:user =&gt; User to change to, must have :group as well. + +</li> +<li>:group =&gt; Group to change to, must have :user as well. + +</li> </ul> </div> </div> - <div id="method-M000118" class="method-detail"> - <a name="M000118"></a> + <div id="method-M000121" class="method-detail"> + <a name="M000121"></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/M000121.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000121.html');return false;"> <span class="method-name">load_mime_map</span><span class="method-args">(file, mime={})</span> </a> </div> <div class="method-description"> @@ -419,16 +425,16 @@ MIME types map is organized. </p> </div> </div> - <div id="method-M000116" class="method-detail"> - <a name="M000116"></a> + <div id="method-M000119" class="method-detail"> + <a name="M000119"></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/M000119.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000119.html');return false;"> <span class="method-name">load_plugins</span><span class="method-args">(options={})</span> </a> </div> <div class="method-description"> @@ -439,16 +445,16 @@ determining the dependencies. </p> </div> </div> - <div id="method-M000117" class="method-detail"> - <a name="M000117"></a> + <div id="method-M000120" class="method-detail"> + <a name="M000120"></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/M000120.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000120.html');return false;"> <span class="method-name">load_yaml</span><span class="method-args">(file, default={})</span> </a> </div> <div class="method-description"> @@ -456,16 +462,16 @@ Easy way to load a YAML file and apply default settings. </p> </div> </div> - <div id="method-M000127" class="method-detail"> - <a name="M000127"></a> + <div id="method-M000130" class="method-detail"> + <a name="M000130"></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/M000130.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000130.html');return false;"> <span class="method-name">log</span><span class="method-args">(msg)</span> </a> </div> <div class="method-description"> @@ -473,16 +479,16 @@ Logs a simple message to STDERR (or the mongrel log if in daemon mode). </p> </div> </div> - <div id="method-M000119" class="method-detail"> - <a name="M000119"></a> + <div id="method-M000122" class="method-detail"> + <a name="M000122"></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/M000122.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000122.html');return false;"> <span class="method-name">plugin</span><span class="method-args">(name, options={})</span> </a> </div> <div class="method-description"> @@ -492,16 +498,16 @@ to passing them in. </p> </div> </div> - <div id="method-M000120" class="method-detail"> - <a name="M000120"></a> + <div id="method-M000123" class="method-detail"> + <a name="M000123"></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/M000123.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000123.html');return false;"> <span class="method-name">redirect</span><span class="method-args">(from, pattern, replacement = nil, &amp;block)</span> </a> </div> <div class="method-description"> @@ -516,16 +522,16 @@ redirect(&quot;/hey&quot;, /(w+)/) {|match| ...} # block </pre> </div> </div> - <div id="method-M000112" class="method-detail"> - <a name="M000112"></a> + <div id="method-M000115" class="method-detail"> + <a name="M000115"></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/M000115.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000115.html');return false;"> <span class="method-name">resolve_defaults</span><span class="method-args">(options)</span> </a> </div> <div class="method-description"> @@ -534,36 +540,36 @@ used internally. </p> </div> </div> - <div id="method-M000121" class="method-detail"> - <a name="M000121"></a> + <div id="method-M000124" class="method-detail"> + <a name="M000124"></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/M000124.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000124.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#M000123">Configurator.join</a> method to prevent +href="Configurator.html#M000126">Configurator.join</a> method to prevent Ruby from exiting until each one is done. </p> </div> </div> - <div id="method-M000125" class="method-detail"> - <a name="M000125"></a> + <div id="method-M000128" class="method-detail"> + <a name="M000128"></a> <div class="method-heading"> - <a href="Configurator.src/M000125.html" target="Code" class="method-signature" - onclick="popupCode('Configurator.src/M000125.html');return false;"> + <a href="Configurator.src/M000128.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000128.html');return false;"> <span class="method-name">run_config</span><span class="method-args">(script)</span> </a> </div> <div class="method-description"> @@ -575,16 +581,16 @@ href="Configurator.html">Configurator</a> statements. </p> </div> </div> - <div id="method-M000126" class="method-detail"> - <a name="M000126"></a> + <div id="method-M000129" class="method-detail"> + <a name="M000129"></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/M000129.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000129.html');return false;"> <span class="method-name">setup_signals</span><span class="method-args">(options={})</span> </a> </div> <div class="method-description"> @@ -593,27 +599,27 @@ configures if the platform is not win32 and doesn&#8217;t do a HUP signal since this is typically framework specific. </p> <p> Requires a :pid_file option given to <a -href="Configurator.html#M000107">Configurator.new</a> to indicate a file to +href="Configurator.html#M000110">Configurator.new</a> to indicate a file to delete. It sets the MongrelConfig.needs_restart attribute if the start command should reload. It&#8217;s up to you to detect this and do whatever is needed for a &quot;restart&quot;. </p> <p> This command is safely ignored if the platform is win32 (with a warning) </p> </div> </div> - <div id="method-M000122" class="method-detail"> - <a name="M000122"></a> + <div id="method-M000125" class="method-detail"> + <a name="M000125"></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/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> </div> <div class="method-description"> @@ -623,24 +629,24 @@ restart and that the pid file should be unlinked on exit. </p> </div> </div> - <div id="method-M000114" class="method-detail"> - <a name="M000114"></a> + <div id="method-M000117" class="method-detail"> + <a name="M000117"></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/M000117.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000117.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#M000113">Configurator.listener</a> block in order +href="Configurator.html#M000116">Configurator.listener</a> block in order to add URI-&gt;handler mappings for that listener. Use this as many times as you like. It expects the following options or defaults: </p> <ul> <li>:handler =&gt; <a href="HttpHandler.html">HttpHandler</a> &#8212; Handler @@ -653,15 +659,15 @@ </li> </ul> </div> </div> - <div id="method-M000109" class="method-detail"> - <a name="M000109"></a> + <div id="method-M000112" class="method-detail"> + <a name="M000112"></a> <div class="method-heading"> - <a href="Configurator.src/M000109.html" target="Code" class="method-signature" - onclick="popupCode('Configurator.src/M000109.html');return false;"> + <a href="Configurator.src/M000112.html" target="Code" class="method-signature" + onclick="popupCode('Configurator.src/M000112.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