%PDF-
%PDF-
Mini Shell
Mini Shell
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Rack::Reloader - rack-2.2.10 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">Object
</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-call">#call</a>
<li ><a href="#method-i-reload-21">#reload!</a>
<li ><a href="#method-i-safe_load">#safe_load</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Rack::Reloader">
<h1 id="class-Rack::Reloader" class="class">
class Rack::Reloader
</h1>
<section class="description">
<p>High performant source reloader</p>
<p>This class acts as <a href="../Rack.html"><code>Rack</code></a> middleware.</p>
<p>What makes it especially suited for use in a production environment is that any file will only be checked once and there will only be made one system call stat(2).</p>
<p>Please note that this will not reload files in the background, it does so only when actively called.</p>
<p>It is performing a check/reload cycle at the start of every request, but also respects a cool down time, during which nothing will be done.</p>
</section>
<section id="5Buntitled-5D" class="documentation-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">(app, cooldown = 10, backend = Stat)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rack/reloader.rb, line 27</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">app</span>, <span class="ruby-identifier">cooldown</span> = <span class="ruby-value">10</span>, <span class="ruby-identifier">backend</span> = <span class="ruby-constant">Stat</span>)
<span class="ruby-ivar">@app</span> = <span class="ruby-identifier">app</span>
<span class="ruby-ivar">@cooldown</span> = <span class="ruby-identifier">cooldown</span>
<span class="ruby-ivar">@last</span> = (<span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">cooldown</span>)
<span class="ruby-ivar">@cache</span> = {}
<span class="ruby-ivar">@mtimes</span> = {}
<span class="ruby-ivar">@reload_mutex</span> = <span class="ruby-constant">Mutex</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">extend</span> <span class="ruby-identifier">backend</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-call" class="method-detail ">
<div class="method-heading">
<span class="method-name">call</span><span
class="method-args">(env)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="call-source">
<pre><span class="ruby-comment"># File lib/rack/reloader.rb, line 38</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">call</span>(<span class="ruby-identifier">env</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@cooldown</span> <span class="ruby-keyword">and</span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">></span> <span class="ruby-ivar">@last</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@cooldown</span>
<span class="ruby-keyword">if</span> <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">list</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span>
<span class="ruby-ivar">@reload_mutex</span>.<span class="ruby-identifier">synchronize</span>{ <span class="ruby-identifier">reload!</span> }
<span class="ruby-keyword">else</span>
<span class="ruby-identifier">reload!</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@last</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@app</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">env</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-reload-21" class="method-detail ">
<div class="method-heading">
<span class="method-name">reload!</span><span
class="method-args">(stderr = $stderr)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="reload-21-source">
<pre><span class="ruby-comment"># File lib/rack/reloader.rb, line 52</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reload!</span>(<span class="ruby-identifier">stderr</span> = <span class="ruby-identifier">$stderr</span>)
<span class="ruby-identifier">rotation</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span>, <span class="ruby-identifier">mtime</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">previous_mtime</span> = <span class="ruby-ivar">@mtimes</span>[<span class="ruby-identifier">file</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">mtime</span>
<span class="ruby-identifier">safe_load</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">mtime</span>, <span class="ruby-identifier">stderr</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">mtime</span> <span class="ruby-operator">></span> <span class="ruby-identifier">previous_mtime</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-safe_load" class="method-detail ">
<div class="method-heading">
<span class="method-name">safe_load</span><span
class="method-args">(file, mtime, stderr = $stderr)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>A safe Kernel::load, issuing the hooks depending on the results</p>
<div class="method-source-code" id="safe_load-source">
<pre><span class="ruby-comment"># File lib/rack/reloader.rb, line 60</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">safe_load</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">mtime</span>, <span class="ruby-identifier">stderr</span> = <span class="ruby-identifier">$stderr</span>)
<span class="ruby-identifier">load</span>(<span class="ruby-identifier">file</span>)
<span class="ruby-identifier">stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"#{self.class}: reloaded `#{file}'"</span>
<span class="ruby-identifier">file</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">LoadError</span>, <span class="ruby-constant">SyntaxError</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">ex</span>
<span class="ruby-identifier">stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">ex</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-ivar">@mtimes</span>[<span class="ruby-identifier">file</span>] = <span class="ruby-identifier">mtime</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>
Zerion Mini Shell 1.0