<!DOCTYPE html>
<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
<title>class CacheManager - TeensyMUD 3.0.0 Mud Server</title>
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
<script type="text/javascript">
var rdoc_rel_prefix = "./";
</script>
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
<body id="top" class="class">
<nav id="metadata">
<nav id="home-section" class="section">
<h3 class="section-header">
<a href="./index.html">Home</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</h3>
</nav>
<nav id="search-section" class="section project-section" class="initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<h3 class="section-header">
<input type="text" name="search" placeholder="Search" id="search-field"
title="Type to search, Up and Down to navigate, Enter to load">
</h3>
</form>
<ul id="search-results" class="initially-hidden"></ul>
</nav>
<div id="file-metadata">
<nav id="file-list-section" class="section">
<h3 class="section-header">Defined In</h3>
<ul>
<li>lib/storage/cache.rb
</ul>
</nav>
</div>
<div id="class-metadata">
<nav id="parent-class-section" class="section">
<h3 class="section-header">Parent</h3>
<p class="link"><a href="Object.html">Object</a>
</nav>
<!-- Method Quickref -->
<nav id="method-list-section" class="section">
<h3 class="section-header">Methods</h3>
<ul class="link-list">
<li><a href="#method-c-new">::new</a>
<li><a href="#method-i-delete">#delete</a>
<li><a href="#method-i-get">#get</a>
<li><a href="#method-i-hash">#hash</a>
<li><a href="#method-i-inspect">#inspect</a>
<li><a href="#method-i-keys">#keys</a>
<li><a href="#method-i-makenoswap">#makenoswap</a>
<li><a href="#method-i-makeswap">#makeswap</a>
<li><a href="#method-i-mark">#mark</a>
<li><a href="#method-i-put">#put</a>
<li><a href="#method-i-stats">#stats</a>
<li><a href="#method-i-sync">#sync</a>
<li><a href="#method-i-sync_chain">#sync_chain</a>
</ul>
</nav>
</div>
<div id="project-metadata">
<nav id="fileindex-section" class="section project-section">
<h3 class="section-header">Pages</h3>
<ul>
<li class="file"><a href="./README.html">README</a>
<li class="file"><a href="./TML.html">TML</a>
</ul>
</nav>
<nav id="classindex-section" class="section project-section">
<h3 class="section-header">Class and Module Index</h3>
<ul class="link-list">
<li><a href="./Farts.html">Farts</a>
<li><a href="./Farts/AttributeSyntaxNode.html">Farts::AttributeSyntaxNode</a>
<li><a href="./Farts/CallSyntaxNode.html">Farts::CallSyntaxNode</a>
<li><a href="./Farts/CommandSyntaxNode.html">Farts::CommandSyntaxNode</a>
<li><a href="./Farts/CommentSyntaxNode.html">Farts::CommentSyntaxNode</a>
<li><a href="./Farts/EndSyntaxNode.html">Farts::EndSyntaxNode</a>
<li><a href="./Farts/IfSyntaxNode.html">Farts::IfSyntaxNode</a>
<li><a href="./Farts/Interpreter.html">Farts::Interpreter</a>
<li><a href="./Farts/Lexer.html">Farts::Lexer</a>
<li><a href="./Farts/Lib.html">Farts::Lib</a>
<li><a href="./Farts/LiteralSyntaxNode.html">Farts::LiteralSyntaxNode</a>
<li><a href="./Farts/LocalVarSyntaxNode.html">Farts::LocalVarSyntaxNode</a>
<li><a href="./Farts/Parser.html">Farts::Parser</a>
<li><a href="./Farts/ProgramSyntaxNode.html">Farts::ProgramSyntaxNode</a>
<li><a href="./Farts/SyntaxNode.html">Farts::SyntaxNode</a>
<li><a href="./SQLite.html">SQLite</a>
<li><a href="./SQLite3.html">SQLite3</a>
<li><a href="./SQLite3/Database.html">SQLite3::Database</a>
<li><a href="./SQLite/Database.html">SQLite::Database</a>
<li><a href="./TernaryTrie.html">TernaryTrie</a>
<li><a href="./TernaryTrie/TNode.html">TernaryTrie::TNode</a>
<li><a href="./ASCIICodes.html">ASCIICodes</a>
<li><a href="./Acceptor.html">Acceptor</a>
<li><a href="./Account.html">Account</a>
<li><a href="./BoolExpParser.html">BoolExpParser</a>
<li><a href="./CacheEntry.html">CacheEntry</a>
<li><a href="./CacheManager.html">CacheManager</a>
<li><a href="./CacheStats.html">CacheStats</a>
<li><a href="./Character.html">Character</a>
<li><a href="./Client.html">Client</a>
<li><a href="./Cmd.html">Cmd</a>
<li><a href="./ColorFilter.html">ColorFilter</a>
<li><a href="./Command.html">Command</a>
<li><a href="./Configuration.html">Configuration</a>
<li><a href="./Connection.html">Connection</a>
<li><a href="./Connector.html">Connector</a>
<li><a href="./ConsoleClient.html">ConsoleClient</a>
<li><a href="./CursesClient.html">CursesClient</a>
<li><a href="./DbmStore.html">DbmStore</a>
<li><a href="./DebugFilter.html">DebugFilter</a>
<li><a href="./Dumper.html">Dumper</a>
<li><a href="./Engine.html">Engine</a>
<li><a href="./Event.html">Event</a>
<li><a href="./EventManager.html">EventManager</a>
<li><a href="./Exit.html">Exit</a>
<li><a href="./Filter.html">Filter</a>
<li><a href="./GameObject.html">GameObject</a>
<li><a href="./GdbmStore.html">GdbmStore</a>
<li><a href="./LineIO.html">LineIO</a>
<li><a href="./Loader.html">Loader</a>
<li><a href="./Log.html">Log</a>
<li><a href="./Module.html">Module</a>
<li><a href="./Obj.html">Obj</a>
<li><a href="./ObjCmd.html">ObjCmd</a>
<li><a href="./Object.html">Object</a>
<li><a href="./PacketIO.html">PacketIO</a>
<li><a href="./ProtocolStack.html">ProtocolStack</a>
<li><a href="./Publisher.html">Publisher</a>
<li><a href="./Reactor.html">Reactor</a>
<li><a href="./Room.html">Room</a>
<li><a href="./Root.html">Root</a>
<li><a href="./Script.html">Script</a>
<li><a href="./SdbmStore.html">SdbmStore</a>
<li><a href="./Session.html">Session</a>
<li><a href="./SockIO.html">SockIO</a>
<li><a href="./Sqlite3Store.html">Sqlite3Store</a>
<li><a href="./SqliteStore.html">SqliteStore</a>
<li><a href="./Store.html">Store</a>
<li><a href="./String.html">String</a>
<li><a href="./TelnetCodes.html">TelnetCodes</a>
<li><a href="./TelnetFilter.html">TelnetFilter</a>
<li><a href="./TerminalFilter.html">TerminalFilter</a>
<li><a href="./Timer.html">Timer</a>
<li><a href="./Utility.html">Utility</a>
<li><a href="./VT100Codes.html">VT100Codes</a>
<li><a href="./World.html">World</a>
<li><a href="./XmlStore.html">XmlStore</a>
<li><a href="./YamlStore.html">YamlStore</a>
</ul>
</nav>
</div>
</nav>
<div id="documentation">
<h1 class="class">class CacheManager</h1>
<div id="description" class="description">
<p>This class manages the cache. It is initialized by the <a
href="Store.html">Store</a> and front ends the database behind the <a
href="Store.html">Store</a>.</p>
</div><!-- description -->
<section id="5Buntitled-5D" class="documentation-section">
<!-- Methods -->
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
<h3 class="section-header">Public Class Methods</h3>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(db)</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/storage/cache.rb, line 112</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">db</span>)
<span class="ruby-ivar">@cwidth</span> = <span class="ruby-identifier">options</span>[<span class="ruby-string">'cache_width'</span>]
<span class="ruby-ivar">@cdepth</span> = <span class="ruby-identifier">options</span>[<span class="ruby-string">'cache_depth'</span>]
<span class="ruby-ivar">@db</span> = <span class="ruby-identifier">db</span>
<span class="ruby-ivar">@st</span> = <span class="ruby-constant">CacheStats</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@cache</span> = <span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@cwidth</span>) {<span class="ruby-constant">Array</span>.<span class="ruby-identifier">new</span>}
<span class="ruby-ivar">@cwidth</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@cdepth</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">j</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">i</span>] <span class="ruby-operator"><<</span> <span class="ruby-constant">CacheEntry</span>.<span class="ruby-identifier">new</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:cache_size</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- new-source -->
</div>
</div><!-- new-method -->
</section><!-- public-class-method-details -->
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
<h3 class="section-header">Public Instance Methods</h3>
<div id="method-i-delete" class="method-detail ">
<div class="method-heading">
<span class="method-name">delete</span><span
class="method-args">(oid)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>delete an object</p>
<div class="method-source-code" id="delete-source">
<pre><span class="ruby-comment"># File lib/storage/cache.rb, line 254</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">oid</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:deletes</span>)
<span class="ruby-identifier">hv</span> = <span class="ruby-identifier">hash</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-comment"># mark dead in cache
</span>
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">hv</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ce</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ce</span>.<span class="ruby-identifier">oid</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">oid</span>
<span class="ruby-identifier">ce</span>.<span class="ruby-identifier">mark_dead</span>
<span class="ruby-keyword">break</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># delete it from the database
</span>
<span class="ruby-ivar">@db</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">oid</span>.<span class="ruby-identifier">to_s</span>)
<span class="ruby-keyword">end</span></pre>
</div><!-- delete-source -->
</div>
</div><!-- delete-method -->
<div id="method-i-get" class="method-detail ">
<div class="method-heading">
<span class="method-name">get</span><span
class="method-args">(oid)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>gets an object</p>
<dl class="rdoc-list label-list"><dt><code>oid</code>
<dd><ul><li>
<p>integer object id to retrieve</p>
</li></ul>
</dd><dt><code>return</code>
<dd><ul><li>
<p>a reference to the object or nil if none exists</p>
</li></ul>
</dd></dl>
<div class="method-source-code" id="get-source">
<pre><span class="ruby-comment"># File lib/storage/cache.rb, line 151</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">oid</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:reads</span>)
<span class="ruby-identifier">hv</span> = <span class="ruby-identifier">hash</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-comment"># search the cache
</span>
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">hv</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ce</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ce</span>.<span class="ruby-identifier">oid</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">oid</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:cache_read_hits</span>)
<span class="ruby-comment"># need to try putting hot hit to the head of the list?
</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">ce</span>.<span class="ruby-identifier">obj</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># cache miss - search the database
</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@db</span>.<span class="ruby-identifier">has_key?</span> <span class="ruby-identifier">oid</span>.<span class="ruby-identifier">to_s</span>
<span class="ruby-identifier">ret</span> = <span class="ruby-constant">Utility</span>.<span class="ruby-identifier">decode</span>(<span class="ruby-ivar">@db</span>[<span class="ruby-identifier">oid</span>.<span class="ruby-identifier">to_s</span>])
<span class="ruby-keyword">else</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:database_read_fails</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:database_reads</span>)
<span class="ruby-comment"># get and remove the last entry off this list
</span>
<span class="ruby-identifier">ch</span> = <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">hv</span>].<span class="ruby-identifier">pop</span>
<span class="ruby-comment"># if its dirty we write it to the database
</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ch</span>.<span class="ruby-identifier">dirty?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">ch</span>.<span class="ruby-identifier">dead?</span>
<span class="ruby-ivar">@db</span>[<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">oid</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-constant">Utility</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">obj</span>)
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:database_writes</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ch</span>.<span class="ruby-identifier">noswap?</span> <span class="ruby-comment"># here we have a problem we can't use this
</span>
<span class="ruby-comment"># first push it back onto the list
</span>
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">hv</span>].<span class="ruby-identifier">unshift</span> <span class="ruby-identifier">ch</span>
<span class="ruby-comment"># get ourselves a brand new
</span>
<span class="ruby-identifier">ch</span> = <span class="ruby-constant">CacheEntry</span>.<span class="ruby-identifier">new</span>
<span class="ruby-comment"># problem solved
</span>
<span class="ruby-comment"># the depth of any list chains will be cache_depth + # noswap entries
</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># assign our new object to the cache entry
</span>
<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">obj</span> = <span class="ruby-identifier">ret</span>
<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">oid</span> = <span class="ruby-identifier">oid</span>
<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">clean!</span>
<span class="ruby-comment"># push it to the head of the list
</span>
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">hv</span>].<span class="ruby-identifier">unshift</span> <span class="ruby-identifier">ch</span>
<span class="ruby-identifier">ret</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- get-source -->
</div>
</div><!-- get-method -->
<div id="method-i-hash" class="method-detail ">
<div class="method-heading">
<span class="method-name">hash</span><span
class="method-args">(oid)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Our simple hash algoritm. Our database keys are sequentially assigned
integers, so… I don’t know what would be better.</p>
<div class="method-source-code" id="hash-source">
<pre><span class="ruby-comment"># File lib/storage/cache.rb, line 144</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">hash</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-identifier">oid</span> <span class="ruby-operator">%</span> <span class="ruby-ivar">@cwidth</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- hash-source -->
</div>
</div><!-- hash-method -->
<div id="method-i-inspect" class="method-detail ">
<div class="method-heading">
<span class="method-name">inspect</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>report on the cache map see cmd_dumpcache</p>
<div class="method-source-code" id="inspect-source">
<pre><span class="ruby-comment"># File lib/storage/cache.rb, line 130</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">inspect</span>
<span class="ruby-identifier">str</span> = <span class="ruby-node">"cache width:#{@cwidth} cache depth:#{@cdepth}\n"</span>
<span class="ruby-ivar">@cwidth</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">i</span>].<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ce</span>,<span class="ruby-identifier">j</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ce</span>.<span class="ruby-identifier">dead?</span>
<span class="ruby-identifier">str</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"cache map [#{i}][#{j}] => "</span>
<span class="ruby-identifier">str</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"oid #{ce.oid} object_id #{ce.obj.object_id} dirty? #{ce.dirty?} noswap? #{ce.noswap?}\n"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">str</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- inspect-source -->
</div>
</div><!-- inspect-method -->
<div id="method-i-keys" class="method-detail ">
<div class="method-heading">
<span class="method-name">keys</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>This is provided to traverse the entire object chain. This thrashes the
cache violently. See <a href="Store.html#method-i-each">Store#each</a>.
One needs to question the design of routines that use <a
href="Store.html#method-i-each">Store#each</a> above.</p>
<div class="method-source-code" id="keys-source">
<pre><span class="ruby-comment"># File lib/storage/cache.rb, line 359</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">keys</span>
<span class="ruby-identifier">kys</span> = []
<span class="ruby-ivar">@cwidth</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">i</span>].<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">ce</span><span class="ruby-operator">|</span> <span class="ruby-identifier">kys</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">ce</span>.<span class="ruby-identifier">oid</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">ce</span>.<span class="ruby-identifier">oid</span>.<span class="ruby-identifier">nil?</span> }
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">kys</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- keys-source -->
</div>
</div><!-- keys-method -->
<div id="method-i-makenoswap" class="method-detail ">
<div class="method-heading">
<span class="method-name">makenoswap</span><span
class="method-args">(oid)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Mark an object in the cache as nonswappable</p>
<dl class="rdoc-list label-list"><dt><code>oid</code>
<dd>
<p>is the object id</p>
</dd><dt><code>return</code>
<dd>
<p>undefined</p>
</dd></dl>
<div class="method-source-code" id="makenoswap-source">
<pre><span class="ruby-comment"># File lib/storage/cache.rb, line 319</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">makenoswap</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">oid</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:cache_noswap</span>)
<span class="ruby-identifier">hv</span> = <span class="ruby-identifier">hash</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">hv</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ce</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ce</span>.<span class="ruby-identifier">oid</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">oid</span>
<span class="ruby-identifier">ce</span>.<span class="ruby-identifier">noswap!</span>
<span class="ruby-keyword">return</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># This would indicate we've tried marking it noswap before we did a put.
</span>
<span class="ruby-comment"># A logic error
</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:cache_noswap_misses</span>)
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Marking object nonswappable before put - #{oid}"</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- makenoswap-source -->
</div>
</div><!-- makenoswap-method -->
<div id="method-i-makeswap" class="method-detail ">
<div class="method-heading">
<span class="method-name">makeswap</span><span
class="method-args">(oid)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Mark an object in the cache as swappable</p>
<dl class="rdoc-list label-list"><dt><code>oid</code>
<dd>
<p>is the object id</p>
</dd><dt><code>return</code>
<dd>
<p>undefined</p>
</dd></dl>
<div class="method-source-code" id="makeswap-source">
<pre><span class="ruby-comment"># File lib/storage/cache.rb, line 339</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">makeswap</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">oid</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:cache_swap</span>)
<span class="ruby-identifier">hv</span> = <span class="ruby-identifier">hash</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">hv</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ce</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ce</span>.<span class="ruby-identifier">oid</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">oid</span>
<span class="ruby-identifier">ce</span>.<span class="ruby-identifier">swap!</span>
<span class="ruby-keyword">return</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># This would indicate we've tried marking it swap before we did a put.
</span>
<span class="ruby-comment"># A logic error
</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:cache_swap_misses</span>)
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Marking object swappable before put - #{oid}"</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- makeswap-source -->
</div>
</div><!-- makeswap-method -->
<div id="method-i-mark" class="method-detail ">
<div class="method-heading">
<span class="method-name">mark</span><span
class="method-args">(oid)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>deliberately mark an object in the cache as dirty see properties.</p>
<div class="method-source-code" id="mark-source">
<pre><span class="ruby-comment"># File lib/storage/cache.rb, line 271</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">mark</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">oid</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:cache_marks</span>)
<span class="ruby-identifier">hv</span> = <span class="ruby-identifier">hash</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">hv</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ce</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ce</span>.<span class="ruby-identifier">oid</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">oid</span>
<span class="ruby-identifier">ce</span>.<span class="ruby-identifier">dirty!</span>
<span class="ruby-keyword">return</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># this would indicate we've tried marking it dirty before we did a put.
</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:cache_mark_misses</span>)
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Marking object dirty before put - #{oid}"</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- mark-source -->
</div>
</div><!-- mark-method -->
<div id="method-i-put" class="method-detail ">
<div class="method-heading">
<span class="method-name">put</span><span
class="method-args">(obj)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>puts an object</p>
<dl class="rdoc-list label-list"><dt><code>obj</code>
<dd><ul><li>
<p>The integer object id to retrieve</p>
</li></ul>
</dd><dt><code>return</code>
<dd><ul><li>
<p>undefined</p>
</li></ul>
</dd></dl>
<div class="method-source-code" id="put-source">
<pre><span class="ruby-comment"># File lib/storage/cache.rb, line 203</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">put</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:writes</span>)
<span class="ruby-identifier">hv</span> = <span class="ruby-identifier">hash</span>(<span class="ruby-identifier">obj</span>.<span class="ruby-identifier">id</span>)
<span class="ruby-comment"># search the cache
</span>
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">hv</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ce</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ce</span>.<span class="ruby-identifier">oid</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">id</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:cache_write_hits</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">ce</span>.<span class="ruby-identifier">dirty?</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">object_id</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">ce</span>.<span class="ruby-identifier">obj</span>.<span class="ruby-identifier">object_id</span> <span class="ruby-comment"># be safe
</span>
<span class="ruby-comment"># Be extra careful here. It's possible we could have two objects
</span>
<span class="ruby-comment"># with the same object id but with different Ruby object_ids.
</span>
<span class="ruby-comment"># Most likely this is a bug, but we should handle it here..
</span>
<span class="ruby-identifier">ce</span>.<span class="ruby-identifier">obj</span> = <span class="ruby-identifier">obj</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">warn</span> <span class="ruby-string">"Duplicate object id's in cache!"</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">warn</span> <span class="ruby-node">"insert - #{obj.inspect}"</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">warn</span> <span class="ruby-node">"cache - #{obj.inspect}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># need to try putting hot hit to the head of the list?
</span>
<span class="ruby-identifier">ce</span>.<span class="ruby-identifier">dirty!</span>
<span class="ruby-keyword">return</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># get and remove the last entry off this list
</span>
<span class="ruby-identifier">ch</span> = <span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">hv</span>].<span class="ruby-identifier">pop</span>
<span class="ruby-comment"># if its dirty we write it to the database
</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ch</span>.<span class="ruby-identifier">dirty?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">ch</span>.<span class="ruby-identifier">dead?</span>
<span class="ruby-comment"># errors possible - check in store module
</span>
<span class="ruby-ivar">@db</span>[<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">oid</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-constant">Utility</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">obj</span>)
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:database_writes</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ch</span>.<span class="ruby-identifier">noswap?</span> <span class="ruby-comment"># here we have a problem we can't use this
</span>
<span class="ruby-comment"># first push it back onto the list
</span>
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">hv</span>].<span class="ruby-identifier">unshift</span> <span class="ruby-identifier">ch</span>
<span class="ruby-comment"># get ourselves a brand new
</span>
<span class="ruby-identifier">ch</span> = <span class="ruby-constant">CacheEntry</span>.<span class="ruby-identifier">new</span>
<span class="ruby-comment"># problem solved
</span>
<span class="ruby-comment"># the depth of any list chains will be cache_depth + # noswap entries
</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-comment"># assign our new object to the cache entry
</span>
<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">obj</span> = <span class="ruby-identifier">obj</span>
<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">oid</span> = <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">id</span>
<span class="ruby-identifier">ch</span>.<span class="ruby-identifier">dirty!</span>
<span class="ruby-comment"># push it to the head of the list
</span>
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">hv</span>].<span class="ruby-identifier">unshift</span> <span class="ruby-identifier">ch</span>
<span class="ruby-keyword">return</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- put-source -->
</div>
</div><!-- put-method -->
<div id="method-i-stats" class="method-detail ">
<div class="method-heading">
<span class="method-name">stats</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>produce a report - see cmd_stats</p>
<div class="method-source-code" id="stats-source">
<pre><span class="ruby-comment"># File lib/storage/cache.rb, line 368</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">stats</span>
<span class="ruby-identifier">str</span> = <span class="ruby-string">"----------* Cache Statistics *----------\n"</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">str</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">sprintf</span>(<span class="ruby-string">"%25-25s : %d\n"</span>,<span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">%r_/</span>,<span class="ruby-string">' '</span>),<span class="ruby-identifier">v</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">str</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"----------* *----------\n"</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- stats-source -->
</div>
</div><!-- stats-method -->
<div id="method-i-sync" class="method-detail ">
<div class="method-heading">
<span class="method-name">sync</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>syncronize the entire cache with the database called by save.</p>
<div class="method-source-code" id="sync-source">
<pre><span class="ruby-comment"># File lib/storage/cache.rb, line 289</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">sync</span>
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:cache_syncs</span>)
<span class="ruby-comment"># search the list chains for dirty objects and write them out.
</span>
<span class="ruby-ivar">@cwidth</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">i</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ce</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ce</span>.<span class="ruby-identifier">dirty?</span>
<span class="ruby-ivar">@db</span>[<span class="ruby-identifier">ce</span>.<span class="ruby-identifier">oid</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-constant">Utility</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-identifier">ce</span>.<span class="ruby-identifier">obj</span>)
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:database_writes</span>)
<span class="ruby-identifier">ce</span>.<span class="ruby-identifier">clean!</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- sync-source -->
</div>
</div><!-- sync-method -->
<div id="method-i-sync_chain" class="method-detail ">
<div class="method-heading">
<span class="method-name">sync_chain</span><span
class="method-args">(i)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>syncronize a specific list chain not yet called but included for possible
performance enhancement</p>
<div class="method-source-code" id="sync_chain-source">
<pre><span class="ruby-comment"># File lib/storage/cache.rb, line 305</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">sync_chain</span>(<span class="ruby-identifier">i</span>)
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:chain_syncs</span>)
<span class="ruby-ivar">@cache</span>[<span class="ruby-identifier">i</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ce</span><span class="ruby-operator">|</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">ce</span>.<span class="ruby-identifier">dirty?</span>
<span class="ruby-ivar">@db</span>[<span class="ruby-identifier">ce</span>.<span class="ruby-identifier">oid</span>.<span class="ruby-identifier">to_s</span>] = <span class="ruby-constant">Utility</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-identifier">ce</span>.<span class="ruby-identifier">obj</span>)
<span class="ruby-ivar">@st</span>.<span class="ruby-identifier">inc</span>(<span class="ruby-value">:database_writes</span>)
<span class="ruby-identifier">ce</span>.<span class="ruby-identifier">clean!</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- sync_chain-source -->
</div>
</div><!-- sync_chain-method -->
</section><!-- public-instance-method-details -->
</section><!-- 5Buntitled-5D -->
</div><!-- documentation -->
<footer id="validator-badges">
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.1.
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>
