<!DOCTYPE html> <html> <head> <meta content="text/html; charset=UTF-8" http-equiv="Content-Type"> <title>class CacheEntry - 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-clean-21">#clean!</a> <li><a href="#method-i-dead-3F">#dead?</a> <li><a href="#method-i-dirty-21">#dirty!</a> <li><a href="#method-i-dirty-3F">#dirty?</a> <li><a href="#method-i-mark_dead">#mark_dead</a> <li><a href="#method-i-noswap-21">#noswap!</a> <li><a href="#method-i-noswap-3F">#noswap?</a> <li><a href="#method-i-swap-21">#swap!</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 CacheEntry</h1> <div id="description" class="description"> <p>This is a node in the cache and is a wrapper for the object and keeps flags on the status of the entry.</p> </div><!-- description --> <section id="5Buntitled-5D" class="documentation-section"> <!-- Attributes --> <section id="attribute-method-details" class="method-section section"> <h3 class="section-header">Attributes</h3> <div id="attribute-i-obj" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">obj</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> </div> </div> <div id="attribute-i-oid" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">oid</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> </div> </div> </section><!-- attribute-method-details --> <!-- 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">(oid=nil,obj=nil,dirty=false,noswap=false)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>perhaps add LRU counters as <a href="CacheEntry.html">CacheEntry</a> is pretty dumb</p> <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/storage/cache.rb, line 59</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">oid</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">obj</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">dirty</span>=<span class="ruby-keyword">false</span>,<span class="ruby-identifier">noswap</span>=<span class="ruby-keyword">false</span>) <span class="ruby-ivar">@oid</span>, <span class="ruby-ivar">@obj</span>, <span class="ruby-ivar">@dirty</span>, <span class="ruby-ivar">@noswap</span> = <span class="ruby-identifier">oid</span>, <span class="ruby-identifier">obj</span>, <span class="ruby-identifier">dirty</span>, <span class="ruby-identifier">noswap</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-clean-21" class="method-detail "> <div class="method-heading"> <span class="method-name">clean!</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="clean-21-source"> <pre><span class="ruby-comment"># File lib/storage/cache.rb, line 72</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">clean!</span> <span class="ruby-ivar">@dirty</span> = <span class="ruby-keyword">false</span> <span class="ruby-keyword">end</span></pre> </div><!-- clean-21-source --> </div> </div><!-- clean-21-method --> <div id="method-i-dead-3F" class="method-detail "> <div class="method-heading"> <span class="method-name">dead?</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>A dead cache entry is an object that has been deleted</p> <div class="method-source-code" id="dead-3F-source"> <pre><span class="ruby-comment"># File lib/storage/cache.rb, line 77</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">dead?</span> <span class="ruby-ivar">@obj</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">end</span></pre> </div><!-- dead-3F-source --> </div> </div><!-- dead-3F-method --> <div id="method-i-dirty-21" class="method-detail "> <div class="method-heading"> <span class="method-name">dirty!</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="dirty-21-source"> <pre><span class="ruby-comment"># File lib/storage/cache.rb, line 68</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">dirty!</span> <span class="ruby-ivar">@dirty</span> = <span class="ruby-keyword">true</span> <span class="ruby-keyword">end</span></pre> </div><!-- dirty-21-source --> </div> </div><!-- dirty-21-method --> <div id="method-i-dirty-3F" class="method-detail "> <div class="method-heading"> <span class="method-name">dirty?</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>dirty cache entries are those that probably differ from the database</p> <div class="method-source-code" id="dirty-3F-source"> <pre><span class="ruby-comment"># File lib/storage/cache.rb, line 64</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">dirty?</span> <span class="ruby-ivar">@dirty</span> <span class="ruby-keyword">end</span></pre> </div><!-- dirty-3F-source --> </div> </div><!-- dirty-3F-method --> <div id="method-i-mark_dead" class="method-detail "> <div class="method-heading"> <span class="method-name">mark_dead</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="mark_dead-source"> <pre><span class="ruby-comment"># File lib/storage/cache.rb, line 81</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">mark_dead</span> <span class="ruby-ivar">@obj</span> = <span class="ruby-keyword">nil</span> <span class="ruby-ivar">@oid</span> = <span class="ruby-keyword">nil</span> <span class="ruby-ivar">@dirty</span> = <span class="ruby-keyword">false</span> <span class="ruby-ivar">@noswap</span> = <span class="ruby-keyword">false</span> <span class="ruby-keyword">end</span></pre> </div><!-- mark_dead-source --> </div> </div><!-- mark_dead-method --> <div id="method-i-noswap-21" class="method-detail "> <div class="method-heading"> <span class="method-name">noswap!</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="noswap-21-source"> <pre><span class="ruby-comment"># File lib/storage/cache.rb, line 96</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">noswap!</span> <span class="ruby-ivar">@noswap</span> = <span class="ruby-keyword">true</span> <span class="ruby-keyword">end</span></pre> </div><!-- noswap-21-source --> </div> </div><!-- noswap-21-method --> <div id="method-i-noswap-3F" class="method-detail "> <div class="method-heading"> <span class="method-name">noswap?</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>Noswappable cache entries are objects that have non persistent attributes. *heavy sigh* We can never remove these from the cache until specifically marked See makenoswap and makeswap</p> <div class="method-source-code" id="noswap-3F-source"> <pre><span class="ruby-comment"># File lib/storage/cache.rb, line 92</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">noswap?</span> <span class="ruby-ivar">@noswap</span> <span class="ruby-keyword">end</span></pre> </div><!-- noswap-3F-source --> </div> </div><!-- noswap-3F-method --> <div id="method-i-swap-21" class="method-detail "> <div class="method-heading"> <span class="method-name">swap!</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="swap-21-source"> <pre><span class="ruby-comment"># File lib/storage/cache.rb, line 100</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">swap!</span> <span class="ruby-ivar">@noswap</span> = <span class="ruby-keyword">false</span> <span class="ruby-keyword">end</span></pre> </div><!-- swap-21-source --> </div> </div><!-- swap-21-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>