twisted.persisted.journal.base.Journal.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.persisted.journal.base.Journal</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.persisted.html">Package persisted</a> ::
<a href="twisted.persisted.journal.html">Package journal</a> ::
<a href="twisted.persisted.journal.base.html">Module base</a> ::
Class Journal
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.persisted.journal.base.Journal.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Journal</h2>
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.persisted.journal.base.MemoryJournal.html"><code>MemoryJournal</code></a>,
<a href="twisted.persisted.journal.rowjournal.RowJournal.html"><code>RowJournal</code></a></dd></dl>
<hr/>
<p>All commands to the system get routed through here.</p>
Subclasses should implement the actual snapshotting capability.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>log</span>,
<span class=summary-sig-arg>journaledService</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.journal.base.Journal.html#_reallyExecute" class="summary-sig-name"><code>_reallyExecute</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>index</span>,
<span class=summary-sig-arg>command</span>,
<span class=summary-sig-arg>runTime</span>)</span></code>
<br />
Callback called when logging command is done.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.journal.base.Journal.html#executeCommand" class="summary-sig-name"><code>executeCommand</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>command</span>)</span></code>
<br />
Log and execute a command.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.journal.base.Journal.html#getLastSnapshot" class="summary-sig-name"><code>getLastSnapshot</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return command index of the last snapshot taken.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.journal.base.Journal.html#sync" class="summary-sig-name"><code>sync</code></a>(<span class=summary-sig-arg>self</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kwargs</span>)</span></code>
<br />
Save journal to disk, returns Deferred of finish status.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.journal.base.Journal.html#updateFromLog" class="summary-sig-name"><code>updateFromLog</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Run all commands from log that haven't been run yet.</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="_reallyExecute"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_reallyExecute</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>index</span>,
<span class=sig-arg>command</span>,
<span class=sig-arg>runTime</span>)</span>
</h3>
Callback called when logging command is done.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="executeCommand"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">executeCommand</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>command</span>)</span>
</h3>
Log and execute a command.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getLastSnapshot"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getLastSnapshot</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return command index of the last snapshot taken.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="sync"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">sync</span>(<span class=sig-arg>self</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kwargs</span>)</span>
</h3>
<p>Save journal to disk, returns Deferred of finish status.</p>
Subclasses may choose whatever signature is appropriate, or may not
implement this at all.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="updateFromLog"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">updateFromLog</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Run all commands from log that haven't been run yet.</p>
This method should be run on startup to ensure the snapshot is
up-to-date.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:59 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>