<!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>
<meta name="Content-Type" content="text/html; charset=utf-8" />
<title>Module: Thinner</title>
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="header">
<div id="menu">
<a href="_index.html">Index (T)</a> »
<span class="title">Thinner</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a id="class_list_link" href="#">Class List</a>
<a id="method_list_link" href="#">Method List</a>
<a id ="file_list_link" href="#">File List</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Thinner
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/thinner.rb<span class="defines">,<br />
lib/thinner/client.rb,<br /> lib/thinner/purger.rb,<br /> lib/thinner/command_line.rb,<br /> lib/thinner/configuration.rb</span>
</dd>
</dl>
<div class="clear"></div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Thinner/Client.html" title="Thinner::Client (class)">Client</a></span>, <span class='object_link'><a href="Thinner/CommandLine.html" title="Thinner::CommandLine (class)">CommandLine</a></span>, <span class='object_link'><a href="Thinner/Configuration.html" title="Thinner::Configuration (class)">Configuration</a></span>, <span class='object_link'><a href="Thinner/Purger.html" title="Thinner::Purger (class)">Purger</a></span>
</p>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="ROOT-constant" class="">ROOT =
<div class="docstring">
<div class="discussion">
<p>
The base location of the Thinner gem.
</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='File constant id'>File</span><span class='dot token'>.</span><span class='expand_path identifier id'>expand_path</span> <span class='dstring node'>"#{File.dirname __FILE__}/.."</span>
</pre></dd>
<dt id="VERSION-constant" class="">VERSION =
<div class="docstring">
<div class="discussion">
<p>
The Thinner version.
</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='File constant id'>File</span><span class='dot token'>.</span><span class='read identifier id'>read</span><span class='lparen token'>(</span><span class='dstring node'>"#{ROOT}/VERSION"</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='chomp identifier id'>chomp</span>
</pre></dd>
<dt id="PROCESS_IDENTIFIER-constant" class="">PROCESS_IDENTIFIER =
<div class="docstring">
<div class="discussion">
<p>
The process label to run each Thinner::Client under.
</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='string val'>"Thinner"</span>
</pre></dd>
</dl>
<h2>Class Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#configuration-class_method" title="configuration (class method)">+ (Object) <strong>configuration</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>
Returns the value of attribute configuration.
</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#configure-class_method" title="configure (class method)">+ (Object) <strong>configure</strong> {|configuration| ... }</a>
</span>
<span class="summary_desc"><div class='inline'><p>
Set any thinner settings by passing in a block.
</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#purge%21-class_method" title="purge! (class method)">+ (Object) <strong>purge!</strong>(urls) </a>
</span>
<span class="summary_desc"><div class='inline'><p>
Begin purging urls.
</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stop%21-class_method" title="stop! (class method)">+ (Object) <strong>stop!</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>
Halt any running instances of Thinner::Client.
</p>
</div></span>
</li>
</ul>
<div id="class_attr_details" class="attr_details">
<h2>Class Attribute Details</h2>
<span id="configuration=-class_method"></span>
<span id="configuration-class_method"></span>
<div class="method_details first">
<p class="signature first" id="configuration-class_method">
+ (<tt>Object</tt>) <strong>configuration</strong>
</p><div class="docstring">
<div class="discussion">
<p>
Returns the value of attribute configuration
</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/thinner.rb', line 13</span>
<span class='def def kw'>def</span> <span class='configuration identifier id'>configuration</span>
<span class='@configuration ivar id'>@configuration</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<p class="signature first" id="configure-class_method">
+ (<tt>Object</tt>) <strong>configure</strong> {|configuration| ... }
</p><div class="docstring">
<div class="discussion">
<p>
Set any thinner settings by passing in a block.
</p>
</div>
</div>
<div class="tags">
<h3>Yields:</h3>
<ul class="yield">
<li>
<span class='type'>(<tt><span class='object_link'><a href="#configuration-class_method" title="Thinner.configuration (method)">configuration</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/thinner.rb', line 16</span>
<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='configure identifier id'>configure</span>
<span class='self self kw'>self</span><span class='dot token'>.</span><span class='configuration identifier id'>configuration</span> <span class='opasgn op'>||=</span> <span class='Configuration constant id'>Configuration</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
<span class='yield yield kw'>yield</span> <span class='configuration identifier id'>configuration</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="purge!-class_method">
+ (<tt>Object</tt>) <strong>purge!</strong>(urls)
</p><div class="docstring">
<div class="discussion">
<p>
Begin purging urls.
</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/thinner.rb', line 27</span>
<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='purge! fid id'>purge!</span> <span class='urls identifier id'>urls</span>
<span class='Purger constant id'>Purger</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='urls identifier id'>urls</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='purge! fid id'>purge!</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="stop!-class_method">
+ (<tt>Object</tt>) <strong>stop!</strong>
</p><div class="docstring">
<div class="discussion">
<p>
Halt any running instances of Thinner::Client
</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
22
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/thinner.rb', line 22</span>
<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='stop! fid id'>stop!</span>
<span class='Purger constant id'>Purger</span><span class='dot token'>.</span><span class='stop! fid id'>stop!</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Nov 22 12:10:39 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.6.1 (ruby-1.8.7).
</div>
</body>
</html>