<?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: Engine</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">Engine</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/lib/engine/engine_rb.html">
lib/engine/engine.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,101,77,149" href="Engine.html" alt="Engine
" />
<area shape="rect" coords="5,5,77,53" href="Singleton.html" alt="Singleton
" />
</map>
<img src="../dot/f_17.png" usemap="#map" border="0" alt="dot/f_17.png">
</div>
<div id="description">
<p>
The <a href="Engine.html">Engine</a> class sets up the server, polls it
regularly and observes acceptor for incoming connections.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000045">graceful_shutdown</a>
<a href="#M000044">handle_signal</a>
<a href="#M000041">new</a>
<a href="#M000042">run</a>
<a href="#M000043">update</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="includes">
<h3 class="section-bar">Included Modules</h3>
<div id="includes-list">
<span class="include-name">Singleton</span>
</div>
</div>
<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">db</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">eventmgr</td>
<td class="context-item-value"> [R] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">shutdown</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">world</td>
<td class="context-item-value"> [R] </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-M000041" class="method-detail">
<a name="M000041"></a>
<div class="method-heading">
<a href="#M000041" class="method-signature">
<span class="method-name">new</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Create the an engine.
</p>
<dl>
<dt><tt>return</tt></dt><dd>A handle to the engine.
</dd>
</dl>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000041-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000041-source">
<pre>
<span class="ruby-comment cmt"># File lib/engine/engine.rb, line 42</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
<span class="ruby-comment cmt"># Display options</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">debug</span> <span class="ruby-node">"Configuration: #{options.inspect}"</span>
<span class="ruby-ivar">@shutdown</span> = <span class="ruby-keyword kw">false</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'trace'</span>]
<span class="ruby-identifier">set_trace_func</span> <span class="ruby-identifier">proc</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">event</span>, <span class="ruby-identifier">file</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">binding</span>, <span class="ruby-identifier">classname</span><span class="ruby-operator">|</span>
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">file</span> <span class="ruby-operator">!~</span> <span class="ruby-regexp re">/\/usr\/lib\/ruby/</span>
<span class="ruby-identifier">printf</span> <span class="ruby-value str">"%8s %s:%-2d %10s %8s\n"</span>, <span class="ruby-identifier">event</span>, <span class="ruby-identifier">file</span>, <span class="ruby-identifier">line</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">classname</span>
<span class="ruby-keyword kw">end</span>
}
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000045" class="method-detail">
<a name="M000045"></a>
<div class="method-heading">
<a href="#M000045" class="method-signature">
<span class="method-name">graceful_shutdown</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000045-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000045-source">
<pre>
<span class="ruby-comment cmt"># File lib/engine/engine.rb, line 129</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">graceful_shutdown</span>
<span class="ruby-ivar">@world</span>.<span class="ruby-identifier">shutdown</span>
<span class="ruby-ivar">@server</span>.<span class="ruby-identifier">stop</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">"Saving world..."</span>
<span class="ruby-ivar">@db</span>.<span class="ruby-identifier">save</span>
<span class="ruby-ivar">@db</span>.<span class="ruby-identifier">close</span>
<span class="ruby-identifier">exit</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000044" class="method-detail">
<a name="M000044"></a>
<div class="method-heading">
<a href="#M000044" class="method-signature">
<span class="method-name">handle_signal</span><span class="method-args">(sig)</span>
</a>
</div>
<div class="method-description">
<p>
Setup traps - invoke one of these signals to shut down the mud
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000044-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000044-source">
<pre>
<span class="ruby-comment cmt"># File lib/engine/engine.rb, line 124</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">handle_signal</span>(<span class="ruby-identifier">sig</span>)
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">warn</span> <span class="ruby-value str">"Signal caught request to shutdown."</span>
<span class="ruby-identifier">graceful_shutdown</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000042" class="method-detail">
<a name="M000042"></a>
<div class="method-heading">
<a href="#M000042" class="method-signature">
<span class="method-name">run</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
main loop to <a href="Engine.html#M000042">run</a> engine.
</p>
<table>
<tr><td valign="top">note:</td><td>@shutdown never set by anyone yet
</td></tr>
</table>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000042-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000042-source">
<pre>
<span class="ruby-comment cmt"># File lib/engine/engine.rb, line 57</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>
<span class="ruby-keyword kw">case</span> <span class="ruby-identifier">options</span>[<span class="ruby-value str">'dbtype'</span>]
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:yaml</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'storage/yamlstore'</span>
<span class="ruby-ivar">@db</span> = <span class="ruby-constant">YamlStore</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value str">'dbfile'</span>])
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:xml</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'storage/xmlstore'</span>
<span class="ruby-ivar">@db</span> = <span class="ruby-constant">XmlStore</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value str">'dbfile'</span>])
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:gdbm</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'storage/gdbmstore'</span>
<span class="ruby-ivar">@db</span> = <span class="ruby-constant">GdbmStore</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value str">'dbfile'</span>])
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:sdbm</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'storage/sdbmstore'</span>
<span class="ruby-ivar">@db</span> = <span class="ruby-constant">SdbmStore</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value str">'dbfile'</span>])
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:dbm</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'storage/dbmstore'</span>
<span class="ruby-ivar">@db</span> = <span class="ruby-constant">DbmStore</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value str">'dbfile'</span>])
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:sqlite</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'storage/sqlitestore'</span>
<span class="ruby-ivar">@db</span> = <span class="ruby-constant">SqliteStore</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value str">'dbfile'</span>])
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:sqlite3</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'storage/sqlite3store'</span>
<span class="ruby-ivar">@db</span> = <span class="ruby-constant">Sqlite3Store</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value str">'dbfile'</span>])
<span class="ruby-keyword kw">else</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">fatal</span> <span class="ruby-value str">"Invalid 'dbtype' in Configuration"</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">RunTimeError</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-comment cmt"># Get the world object</span>
<span class="ruby-ivar">@world</span> = <span class="ruby-ivar">@db</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">0</span>)
<span class="ruby-comment cmt"># log.debug @world.inspect</span>
<span class="ruby-ivar">@db</span>.<span class="ruby-identifier">makenoswap</span>(<span class="ruby-value">0</span>)
<span class="ruby-ivar">@world</span>.<span class="ruby-identifier">startup</span>
<span class="ruby-ivar">@eventmgr</span> = <span class="ruby-constant">EventManager</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">info</span> <span class="ruby-node">"Booting server on port #{options['server_port'] || 4000}"</span>
<span class="ruby-ivar">@server</span> = <span class="ruby-constant">Reactor</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value str">'server_port'</span>] <span class="ruby-operator">||</span> <span class="ruby-value">4000</span>,
<span class="ruby-identifier">options</span>[<span class="ruby-value str">'server_type'</span>], <span class="ruby-identifier">options</span>[<span class="ruby-value str">'server_io'</span>],
<span class="ruby-identifier">options</span>[<span class="ruby-value str">'server_negotiation'</span>], <span class="ruby-identifier">options</span>[<span class="ruby-value str">'server_filters'</span>],
<span class="ruby-identifier">address</span>=<span class="ruby-keyword kw">nil</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-value str">"Unable to start server"</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@server</span>.<span class="ruby-identifier">start</span>(<span class="ruby-keyword kw">self</span>)
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">info</span> <span class="ruby-value str">"TMUD is ready"</span>
<span class="ruby-constant">Signal</span>.<span class="ruby-identifier">trap</span>(<span class="ruby-value str">"INT"</span>, <span class="ruby-identifier">method</span>(<span class="ruby-identifier">:handle_signal</span>))
<span class="ruby-constant">Signal</span>.<span class="ruby-identifier">trap</span>(<span class="ruby-value str">"TERM"</span>, <span class="ruby-identifier">method</span>(<span class="ruby-identifier">:handle_signal</span>))
<span class="ruby-constant">Signal</span>.<span class="ruby-identifier">trap</span>(<span class="ruby-value str">"KILL"</span>, <span class="ruby-identifier">method</span>(<span class="ruby-identifier">:handle_signal</span>))
<span class="ruby-keyword kw">until</span> <span class="ruby-ivar">@shutdown</span>
<span class="ruby-ivar">@server</span>.<span class="ruby-identifier">poll</span>(<span class="ruby-value">0</span><span class="ruby-value">.3</span>)
<span class="ruby-ivar">@eventmgr</span>.<span class="ruby-identifier">process_events</span>
<span class="ruby-keyword kw">end</span> <span class="ruby-comment cmt"># until</span>
<span class="ruby-identifier">graceful_shutdown</span>
<span class="ruby-keyword kw">rescue</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">fatal</span> <span class="ruby-value str">"Engine failed in run"</span>
<span class="ruby-identifier">log</span>.<span class="ruby-identifier">fatal</span> <span class="ruby-identifier">$!</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000043" class="method-detail">
<a name="M000043"></a>
<div class="method-heading">
<a href="#M000043" class="method-signature">
<span class="method-name">update</span><span class="method-args">(newconn)</span>
</a>
</div>
<div class="method-description">
<p>
Update is called by an acceptor passing us a <a
href="Engine.html#M000041">new</a> session. We create an incoming object
and set it and the connection to watch each other.
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000043-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000043-source">
<pre>
<span class="ruby-comment cmt"># File lib/engine/engine.rb, line 116</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">update</span>(<span class="ruby-identifier">newconn</span>)
<span class="ruby-identifier">inc</span> = <span class="ruby-constant">Account</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">newconn</span>)
<span class="ruby-comment cmt"># Observe each other</span>
<span class="ruby-identifier">newconn</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">inc</span>)
<span class="ruby-identifier">inc</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">newconn</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>
