<?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: GdbmStore</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">GdbmStore</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/storage/gdbmstore_rb.html">
lib/storage/gdbmstore.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
<a href="Store.html">
Store
</a>
</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,101,93,149" href="GdbmStore.html" alt="GdbmStore
" />
<area shape="rect" coords="13,5,85,53" href="Store.html" alt="Store
" />
</map>
<img src="../dot/f_44.png" usemap="#map" border="0" alt="dot/f_44.png">
</div>
<div id="description">
<p>
The <a href="GdbmStore.html">GdbmStore</a> class manages access to all
object storage.
</p>
<dl>
<dt><tt>db</tt></dt><dd>is a handle to the database.
</dd>
<dt><tt>dbtop</tt></dt><dd>stores the highest id used in the database.
</dd>
<dt><tt>cache</tt></dt><dd>is a handle to the cache
</dd>
</dl>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000209">check</a>
<a href="#M000204">close</a>
<a href="#M000207">delete</a>
<a href="#M000213">each</a>
<a href="#M000208">get</a>
<a href="#M000205">inspect</a>
<a href="#M000211">makenoswap</a>
<a href="#M000212">makeswap</a>
<a href="#M000210">mark</a>
<a href="#M000202">new</a>
<a href="#M000206">put</a>
<a href="#M000203">save</a>
<a href="#M000214">stats</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-M000202" class="method-detail">
<a name="M000202"></a>
<div class="method-heading">
<a href="#M000202" class="method-signature">
<span class="method-name">new</span><span class="method-args">(dbfile)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000202-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000202-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/gdbmstore.rb, line 29</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">dbfile</span>)
<span class="ruby-keyword kw">super</span>()
<span class="ruby-ivar">@dbfile</span> = <span class="ruby-node">"#{dbfile}.gdbm"</span>
<span class="ruby-comment cmt"># check if database exists and build it if not</span>
<span class="ruby-identifier">build_database</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">"Loading world..."</span>
<span class="ruby-comment cmt"># open database and sets @dbtop to highest object id</span>
<span class="ruby-ivar">@db</span> = <span class="ruby-constant">GDBM</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@dbfile</span>, <span class="ruby-value">0666</span>)
<span class="ruby-ivar">@db</span>.<span class="ruby-identifier">each_key</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">o</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@dbtop</span> = <span class="ruby-identifier">o</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">></span> <span class="ruby-ivar">@dbtop</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-ivar">@cache</span> = <span class="ruby-constant">CacheManager</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@db</span>)
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">info</span> <span class="ruby-node">"Database '#{@dbfile}' loaded...highest id = #{@dbtop}."</span>
<span class="ruby-comment cmt"># log.debug @db.inspect</span>
<span class="ruby-keyword kw">rescue</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">fatal</span> <span class="ruby-identifier">$!</span>
<span class="ruby-identifier">raise</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000209" class="method-detail">
<a name="M000209"></a>
<div class="method-heading">
<a href="#M000209" class="method-signature">
<span class="method-name">check</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
Check if an object is in the database by its id.
</p>
<dl>
<dt><tt>oid</tt></dt><dd>is the id to use in the search.
</dd>
<dt><tt>return</tt></dt><dd>true or false
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000209-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000209-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/gdbmstore.rb, line 94</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">check</span>(<span class="ruby-identifier">oid</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-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000204" class="method-detail">
<a name="M000204"></a>
<div class="method-heading">
<a href="#M000204" class="method-signature">
<span class="method-name">close</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Close the database
</p>
<dl>
<dt><tt>return</tt></dt><dd>Undefined.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000204-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000204-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/gdbmstore.rb, line 59</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">close</span>
<span class="ruby-ivar">@db</span>.<span class="ruby-identifier">close</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000207" class="method-detail">
<a name="M000207"></a>
<div class="method-heading">
<a href="#M000207" class="method-signature">
<span class="method-name">delete</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
Deletes an object from the database.
</p>
<dl>
<dt><tt>oid</tt></dt><dd>is the id to to be deleted.
</dd>
<dt><tt>return</tt></dt><dd>Undefined.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000207-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000207-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/gdbmstore.rb, line 80</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000213" class="method-detail">
<a name="M000213"></a>
<div class="method-heading">
<a href="#M000213" class="method-signature">
<span class="method-name">each</span><span class="method-args">() {|@cache.get(k)}| ...}</span>
</a>
</div>
<div class="method-description">
<p>
Iterate through all objects This needs to have all the possible keys first.
So we need to fetch them from the cache and from the database and and
produce a list of unique keys.
</p>
<dl>
<dt><tt>yield</tt></dt><dd>Each object in database to block of caller.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000213-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000213-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/gdbmstore.rb, line 124</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each</span>
<span class="ruby-identifier">kys</span> = <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">keys</span>
<span class="ruby-ivar">@db</span>.<span class="ruby-identifier">each_key</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-identifier">kys</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_i</span>}
<span class="ruby-identifier">kys</span>.<span class="ruby-identifier">uniq!</span>
<span class="ruby-identifier">kys</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-keyword kw">yield</span> <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">k</span>)}
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000208" class="method-detail">
<a name="M000208"></a>
<div class="method-heading">
<a href="#M000208" class="method-signature">
<span class="method-name">get</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
Finds an object in the database by its id.
</p>
<dl>
<dt><tt>oid</tt></dt><dd>is the id to use in the search.
</dd>
<dt><tt>return</tt></dt><dd>Handle to the object or nil.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000208-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000208-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/gdbmstore.rb, line 87</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000205" class="method-detail">
<a name="M000205"></a>
<div class="method-heading">
<a href="#M000205" class="method-signature">
<span class="method-name">inspect</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
<a href="GdbmStore.html#M000205">inspect</a> the store cache (only for
caches)
</p>
<dl>
<dt><tt>return</tt></dt><dd>string
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000205-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000205-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/gdbmstore.rb, line 65</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inspect</span>
<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">inspect</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000211" class="method-detail">
<a name="M000211"></a>
<div class="method-heading">
<a href="#M000211" class="method-signature">
<span class="method-name">makenoswap</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
Marks an object nonswappable
</p>
<dl>
<dt><tt>oid</tt></dt><dd>is the object id
</dd>
<dt><tt>return</tt></dt><dd>undefined
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000211-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000211-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/gdbmstore.rb, line 108</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">makenoswap</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">makenoswap</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000212" class="method-detail">
<a name="M000212"></a>
<div class="method-heading">
<a href="#M000212" class="method-signature">
<span class="method-name">makeswap</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
Marks an object swappable
</p>
<dl>
<dt><tt>oid</tt></dt><dd>is the object id
</dd>
<dt><tt>return</tt></dt><dd>undefined
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000212-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000212-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/gdbmstore.rb, line 115</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">makeswap</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">makeswap</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000210" class="method-detail">
<a name="M000210"></a>
<div class="method-heading">
<a href="#M000210" class="method-signature">
<span class="method-name">mark</span><span class="method-args">(oid)</span>
</a>
</div>
<div class="method-description">
<p>
Marks an object dirty
</p>
<dl>
<dt><tt>oid</tt></dt><dd>is the id to use in the search.
</dd>
<dt><tt>return</tt></dt><dd>undefined
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000210-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000210-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/gdbmstore.rb, line 101</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">mark</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">mark</span>(<span class="ruby-identifier">oid</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000206" class="method-detail">
<a name="M000206"></a>
<div class="method-heading">
<a href="#M000206" class="method-signature">
<span class="method-name">put</span><span class="method-args">(obj)</span>
</a>
</div>
<div class="method-description">
<p>
Adds a <a href="GdbmStore.html#M000202">new</a> object to the database.
</p>
<dl>
<dt><tt>obj</tt></dt><dd>is a reference to object to be added
</dd>
<dt><tt>return</tt></dt><dd>Undefined.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000206-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000206-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/gdbmstore.rb, line 72</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">put</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">put</span>(<span class="ruby-identifier">obj</span>)
<span class="ruby-identifier">obj</span> <span class="ruby-comment cmt"># return really should not be checked</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000203" class="method-detail">
<a name="M000203"></a>
<div class="method-heading">
<a href="#M000203" class="method-signature">
<span class="method-name">save</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Save the world
</p>
<dl>
<dt><tt>return</tt></dt><dd>Undefined.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000203-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000203-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/gdbmstore.rb, line 53</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">save</span>
<span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">sync</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000214" class="method-detail">
<a name="M000214"></a>
<div class="method-heading">
<a href="#M000214" class="method-signature">
<span class="method-name">stats</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
produces a statistical report of the database
</p>
<dl>
<dt><tt>return</tt></dt><dd>a string containing the report
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000214-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000214-source">
<pre>
<span class="ruby-comment cmt"># File lib/storage/gdbmstore.rb, line 133</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">stats</span>
<span class="ruby-identifier">stats</span> = <span class="ruby-keyword kw">super</span>
<span class="ruby-identifier">stats</span> <span class="ruby-operator"><<</span> <span class="ruby-ivar">@cache</span>.<span class="ruby-identifier">stats</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>
