<?xml version="1.0" encoding="iso-8859-1"?> <!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> <title>Class: CacheEntry</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <meta http-equiv="Content-Script-Type" content="text/javascript" /> <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" /> <script type="text/javascript"> // <![CDATA[ function popupCode( url ) { window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") } function toggleCode( id ) { if ( document.getElementById ) elem = document.getElementById( id ); else if ( document.all ) elem = eval( "document.all." + id ); else return false; elemStyle = elem.style; if ( elemStyle.display != "block" ) { elemStyle.display = "block" } else { elemStyle.display = "none" } return true; } // Make codeblocks hidden by default document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) // ]]> </script> </head> <body> <div id="classHeader"> <table class="header-table"> <tr class="top-aligned-row"> <td><strong>Class</strong></td> <td class="class-name-in-header">CacheEntry</td> </tr> <tr class="top-aligned-row"> <td><strong>In:</strong></td> <td> <a href="../files/lib/storage/cache_rb.html"> lib/storage/cache.rb </a> <br /> </td> </tr> <tr class="top-aligned-row"> <td><strong>Parent:</strong></td> <td> Object </td> </tr> </table> </div> <!-- banner header --> <div id="bodyContent"> <div id="contextContent"> <div id="diagram"> <map id="map" name="map"> <area shape="rect" coords="5,5,96,53" href="CacheStats.html" alt="CacheStats " /> <area shape="rect" coords="120,5,232,53" href="CacheManager.html" alt="CacheManager " /> <area shape="rect" coords="256,5,347,53" href="CacheEntry.html" alt="CacheEntry " /> </map> <img src="../dot/f_42.png" usemap="#map" border="0" alt="dot/f_42.png"> </div> <div id="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> </div> <div id="method-list"> <h3 class="section-bar">Methods</h3> <div class="name-list"> <a href="#M000231">clean!</a> <a href="#M000232">dead?</a> <a href="#M000230">dirty!</a> <a href="#M000229">dirty?</a> <a href="#M000233">mark_dead</a> <a href="#M000228">new</a> <a href="#M000235">noswap!</a> <a href="#M000234">noswap?</a> <a href="#M000236">swap!</a> </div> </div> </div> <!-- if includes --> <div id="section"> <div id="attribute-list"> <h3 class="section-bar">Attributes</h3> <div class="name-list"> <table> <tr class="top-aligned-row context-row"> <td class="context-item-name">obj</td> <td class="context-item-value"> [RW] </td> <td class="context-item-desc"></td> </tr> <tr class="top-aligned-row context-row"> <td class="context-item-name">oid</td> <td class="context-item-value"> [RW] </td> <td class="context-item-desc"></td> </tr> </table> </div> </div> <!-- if method_list --> <div id="methods"> <h3 class="section-bar">Public Class methods</h3> <div id="method-M000228" class="method-detail"> <a name="M000228"></a> <div class="method-heading"> <a href="#M000228" class="method-signature"> <span class="method-name">new</span><span class="method-args">(oid=nil,obj=nil,dirty=false,noswap=false)</span> </a> </div> <div class="method-description"> <p> perhaps add LRU counters as <a href="CacheEntry.html">CacheEntry</a> is pretty dumb </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000228-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000228-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/cache.rb, line 59</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">oid</span>=<span class="ruby-keyword kw">nil</span>,<span class="ruby-identifier">obj</span>=<span class="ruby-keyword kw">nil</span>,<span class="ruby-identifier">dirty</span>=<span class="ruby-keyword kw">false</span>,<span class="ruby-identifier">noswap</span>=<span class="ruby-keyword kw">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 kw">end</span> </pre> </div> </div> </div> <h3 class="section-bar">Public Instance methods</h3> <div id="method-M000231" class="method-detail"> <a name="M000231"></a> <div class="method-heading"> <a href="#M000231" class="method-signature"> <span class="method-name">clean!</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000231-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000231-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/cache.rb, line 72</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">clean!</span> <span class="ruby-ivar">@dirty</span> = <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000232" class="method-detail"> <a name="M000232"></a> <div class="method-heading"> <a href="#M000232" class="method-signature"> <span class="method-name">dead?</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> A dead cache entry is an object that has been deleted </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000232-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000232-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/cache.rb, line 77</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dead?</span> <span class="ruby-ivar">@obj</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000230" class="method-detail"> <a name="M000230"></a> <div class="method-heading"> <a href="#M000230" class="method-signature"> <span class="method-name">dirty!</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000230-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000230-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/cache.rb, line 68</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dirty!</span> <span class="ruby-ivar">@dirty</span> = <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000229" class="method-detail"> <a name="M000229"></a> <div class="method-heading"> <a href="#M000229" class="method-signature"> <span class="method-name">dirty?</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p> dirty cache entries are those that probably differ from the database </p> <p><a class="source-toggle" href="#" onclick="toggleCode('M000229-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000229-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/cache.rb, line 64</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dirty?</span> <span class="ruby-ivar">@dirty</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000233" class="method-detail"> <a name="M000233"></a> <div class="method-heading"> <a href="#M000233" class="method-signature"> <span class="method-name">mark_dead</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000233-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000233-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/cache.rb, line 81</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">mark_dead</span> <span class="ruby-ivar">@obj</span> = <span class="ruby-keyword kw">nil</span> <span class="ruby-ivar">@oid</span> = <span class="ruby-keyword kw">nil</span> <span class="ruby-ivar">@dirty</span> = <span class="ruby-keyword kw">false</span> <span class="ruby-ivar">@noswap</span> = <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000235" class="method-detail"> <a name="M000235"></a> <div class="method-heading"> <a href="#M000235" class="method-signature"> <span class="method-name">noswap!</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000235-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000235-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/cache.rb, line 96</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">noswap!</span> <span class="ruby-ivar">@noswap</span> = <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000234" class="method-detail"> <a name="M000234"></a> <div class="method-heading"> <a href="#M000234" class="method-signature"> <span class="method-name">noswap?</span><span class="method-args">()</span> </a> </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> <p><a class="source-toggle" href="#" onclick="toggleCode('M000234-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000234-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/cache.rb, line 92</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">noswap?</span> <span class="ruby-ivar">@noswap</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> <div id="method-M000236" class="method-detail"> <a name="M000236"></a> <div class="method-heading"> <a href="#M000236" class="method-signature"> <span class="method-name">swap!</span><span class="method-args">()</span> </a> </div> <div class="method-description"> <p><a class="source-toggle" href="#" onclick="toggleCode('M000236-source');return false;">[Source]</a></p> <div class="method-source-code" id="M000236-source"> <pre> <span class="ruby-comment cmt"># File lib/storage/cache.rb, line 100</span> <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">swap!</span> <span class="ruby-ivar">@noswap</span> = <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">end</span> </pre> </div> </div> </div> </div> </div> <div id="validator-badges"> <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> </div> </body> </html>