<?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: CacheManager</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">CacheManager</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="7,17,92,65" href="CacheStats.html" alt="CacheStats
">
<area shape="RECT" coords="116,17,217,65" href="CacheManager.html" alt="CacheManager
">
<area shape="RECT" coords="241,17,327,65" href="CacheEntry.html" alt="CacheEntry
">
</map>
<img src="../dot/f_41.png" usemap="#map" border=0 alt="TopLevel">
</div>
<div id="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>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000113">delete</a>
<a href="#M000111">get</a>
<a href="#M000110">hash</a>
<a href="#M000109">inspect</a>
<a href="#M000119">keys</a>
<a href="#M000117">makenoswap</a>
<a href="#M000118">makeswap</a>
<a href="#M000114">mark</a>
<a href="#M000108">new</a>
<a href="#M000112">put</a>
<a href="#M000120">stats</a>
<a href="#M000115">sync</a>
<a href="#M000116">sync_chain</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000108" class="method-detail">
<a name="M000108"></a>
<div class="method-heading">
<a href="CacheManager.src/M000108.html" target="Code" class="method-signature"
onclick="popupCode('CacheManager.src/M000108.html');return false;">
<span class="method-name">new</span><span class="method-args">(db)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000113" class="method-detail">
<a name="M000113"></a>
<div class="method-heading">
<a href="CacheManager.src/M000113.html" target="Code" class="method-signature"
onclick="popupCode('CacheManager.src/M000113.html');return false;">
<span class="method-name">delete</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
delete an object
</p>
</div>
</div>
<div id="method-M000111" class="method-detail">
<a name="M000111"></a>
<div class="method-heading">
<a href="CacheManager.src/M000111.html" target="Code" class="method-signature"
onclick="popupCode('CacheManager.src/M000111.html');return false;">
<span class="method-name">get</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
gets an object
</p>
<dl>
<dt><tt>oid</tt></dt><dd>- integer object id to retrieve
</dd>
<dt><tt>return</tt></dt><dd>- a reference to the object or nil if none exists
</dd>
</dl>
</div>
</div>
<div id="method-M000110" class="method-detail">
<a name="M000110"></a>
<div class="method-heading">
<a href="CacheManager.src/M000110.html" target="Code" class="method-signature"
onclick="popupCode('CacheManager.src/M000110.html');return false;">
<span class="method-name">hash</span><span class="method-args">(oid)</span>
</a>
</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>
</div>
<div id="method-M000109" class="method-detail">
<a name="M000109"></a>
<div class="method-heading">
<a href="CacheManager.src/M000109.html" target="Code" class="method-signature"
onclick="popupCode('CacheManager.src/M000109.html');return false;">
<span class="method-name">inspect</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
report on the cache map see cmd_dumpcache
</p>
</div>
</div>
<div id="method-M000119" class="method-detail">
<a name="M000119"></a>
<div class="method-heading">
<a href="CacheManager.src/M000119.html" target="Code" class="method-signature"
onclick="popupCode('CacheManager.src/M000119.html');return false;">
<span class="method-name">keys</span><span class="method-args">()</span>
</a>
</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#M000026">Store#each</a>. One needs
to question the design of routines that use <a
href="Store.html#M000026">Store#each</a> above.
</p>
</div>
</div>
<div id="method-M000117" class="method-detail">
<a name="M000117"></a>
<div class="method-heading">
<a href="CacheManager.src/M000117.html" target="Code" class="method-signature"
onclick="popupCode('CacheManager.src/M000117.html');return false;">
<span class="method-name">makenoswap</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
Mark an object in the cache as nonswappable
</p>
<dl>
<dt><tt>oid</tt></dt><dd>is the object id
</dd>
<dt><tt>return</tt></dt><dd>undefined
</dd>
</dl>
</div>
</div>
<div id="method-M000118" class="method-detail">
<a name="M000118"></a>
<div class="method-heading">
<a href="CacheManager.src/M000118.html" target="Code" class="method-signature"
onclick="popupCode('CacheManager.src/M000118.html');return false;">
<span class="method-name">makeswap</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
Mark an object in the cache as swappable
</p>
<dl>
<dt><tt>oid</tt></dt><dd>is the object id
</dd>
<dt><tt>return</tt></dt><dd>undefined
</dd>
</dl>
</div>
</div>
<div id="method-M000114" class="method-detail">
<a name="M000114"></a>
<div class="method-heading">
<a href="CacheManager.src/M000114.html" target="Code" class="method-signature"
onclick="popupCode('CacheManager.src/M000114.html');return false;">
<span class="method-name">mark</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
deliberately mark an object in the cache as dirty see properties.
</p>
</div>
</div>
<div id="method-M000112" class="method-detail">
<a name="M000112"></a>
<div class="method-heading">
<a href="CacheManager.src/M000112.html" target="Code" class="method-signature"
onclick="popupCode('CacheManager.src/M000112.html');return false;">
<span class="method-name">put</span><span class="method-args">(obj)</span>
</a>
</div>
<div class="method-description">
<p>
puts an object
</p>
<dl>
<dt><tt>obj</tt></dt><dd>- The integer object id to retrieve
</dd>
<dt><tt>return</tt></dt><dd>- undefined
</dd>
</dl>
</div>
</div>
<div id="method-M000120" class="method-detail">
<a name="M000120"></a>
<div class="method-heading">
<a href="CacheManager.src/M000120.html" target="Code" class="method-signature"
onclick="popupCode('CacheManager.src/M000120.html');return false;">
<span class="method-name">stats</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
produce a report - see cmd_stats
</p>
</div>
</div>
<div id="method-M000115" class="method-detail">
<a name="M000115"></a>
<div class="method-heading">
<a href="CacheManager.src/M000115.html" target="Code" class="method-signature"
onclick="popupCode('CacheManager.src/M000115.html');return false;">
<span class="method-name">sync</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
syncronize the entire cache with the database called by save.
</p>
</div>
</div>
<div id="method-M000116" class="method-detail">
<a name="M000116"></a>
<div class="method-heading">
<a href="CacheManager.src/M000116.html" target="Code" class="method-signature"
onclick="popupCode('CacheManager.src/M000116.html');return false;">
<span class="method-name">sync_chain</span><span class="method-args">(i)</span>
</a>
</div>
<div class="method-description">
<p>
syncronize a specific list chain not yet called but included for possible
performance enhancement
</p>
</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>
