twisted.python.logfile.LogFile.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.python.logfile.LogFile</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.python.html">Package python</a> ::
<a href="twisted.python.logfile.html">Module logfile</a> ::
Class LogFile
</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.python.logfile.LogFile.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class LogFile</h2>
<pre class="base-tree">
<a href="twisted.python.logfile.BaseLogFile.html"><code>BaseLogFile</code></a> --+
|
<b>LogFile</b>
</pre><br />
<hr/>
<p>A log file that can be rotated.</p>
A rotateLength of None disables automatic log rotation.
<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>name</span>,
<span class=summary-sig-arg>directory</span>,
<span class=summary-sig-arg>rotateLength</span>,
<span class=summary-sig-arg>defaultMode</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__getstate__"></a><span class="summary-sig"><span class="summary-sig-name">__getstate__</span>(<span class=summary-sig-arg>self</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.python.logfile.LogFile.html#rotate" class="summary-sig-name"><code>__hook_orig_twisted_python_logfile_LogFile_rotate__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Rotate the file and create a new one.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.logfile.LogFile.html#write" class="summary-sig-name"><code>__hook_orig_twisted_python_logfile_LogFile_write__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Write some data to the file</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.logfile.LogFile.html#_openFile" class="summary-sig-name"><code>_openFile</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Open the log file.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.logfile.LogFile.html#getLog" class="summary-sig-name"><code>getLog</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>identifier</span>)</span></code>
<br />
Given an integer, return a LogReader for an old log file.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.logfile.LogFile.html#listLogs" class="summary-sig-name"><code>listLogs</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return sorted list of integers - the old logs' identifiers.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="rotate"></a><span class="summary-sig"><span class="summary-sig-name">rotate</span>(<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</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.python.logfile.LogFile.html#shouldRotate" class="summary-sig-name"><code>shouldRotate</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Rotate when the log file size is larger than rotateLength</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="write"></a><span class="summary-sig"><span class="summary-sig-name">write</span>(<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from BaseLogFile</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.logfile.BaseLogFile.html#__setstate__" class="summary-sig-name"><code>__setstate__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>state</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.python.logfile.BaseLogFile.html#close" class="summary-sig-name"><code>close</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Close the file.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.logfile.BaseLogFile.html#flush" class="summary-sig-name"><code>flush</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Flush the file.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.logfile.BaseLogFile.html#getCurrentLog" class="summary-sig-name"><code>getCurrentLog</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a LogReader for the current log file.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.python.logfile.LogFile.html#__hook_post_twisted_python_logfile_LogFile_rotate__"><code>__hook_post_twisted_python_logfile_LogFile_rotate__</code></a></b> = <span title="[<function _synchPost at 0x81d542c>]"><code>[<<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.python.logfile.LogFile.html#__hook_post_twisted_python_logfile_LogFile_write__"><code>__hook_post_twisted_python_logfile_LogFile_write__</code></a></b> = <span title="[<function _synchPost at 0x81d542c>]"><code>[<f<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.python.logfile.LogFile.html#__hook_pre_twisted_python_logfile_LogFile_rotate__"><code>__hook_pre_twisted_python_logfile_LogFile_rotate__</code></a></b> = <span title="[<function _synchPre at 0x823753c>]"><code>[<f<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.python.logfile.LogFile.html#__hook_pre_twisted_python_logfile_LogFile_write__"><code>__hook_pre_twisted_python_logfile_LogFile_write__</code></a></b> = <span title="[<function _synchPre at 0x823753c>]"><code>[<fu<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from BaseLogFile</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.python.logfile.BaseLogFile.html#synchronized"><code>synchronized</code></a></b> = <span title="['write', 'rotate']"><code>['write', 'rotate'] </code>
</span></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="rotate"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__hook_orig_twisted_python_logfile_LogFile_rotate__</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Rotate the file and create a new one.</p>
If it's not possible to open new logfile, this will fail silently,
and continue logging to old logfile.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="write"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__hook_orig_twisted_python_logfile_LogFile_write__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
Write some data to the file
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.python.logfile.BaseLogFile.html#write"><code>twisted.python.logfile.BaseLogFile.write</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_openFile"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_openFile</span>(<span class=sig-arg>self</span>)</span>
</h3>
Open the log file.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.python.logfile.BaseLogFile.html#_openFile"><code>twisted.python.logfile.BaseLogFile._openFile</code></a> <i>(inherited documentation)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getLog"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getLog</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>identifier</span>)</span>
</h3>
Given an integer, return a LogReader for an old log file.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="listLogs"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listLogs</span>(<span class=sig-arg>self</span>)</span>
</h3>
Return sorted list of integers - the old logs' identifiers.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="shouldRotate"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">shouldRotate</span>(<span class=sig-arg>self</span>)</span>
</h3>
Rotate when the log file size is larger than rotateLength
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.python.logfile.BaseLogFile.html#shouldRotate"><code>twisted.python.logfile.BaseLogFile.shouldRotate</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="__hook_post_twisted_python_logfile_LogFile_rotate__"></a>
<h3>__hook_post_twisted_python_logfile_LogFile_rotate__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="[<function _synchPost at 0x81d542c>]"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
[<function _synchPost at 0x81d542c>] </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="__hook_post_twisted_python_logfile_LogFile_write__"></a>
<h3>__hook_post_twisted_python_logfile_LogFile_write__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="[<function _synchPost at 0x81d542c>]"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
[<function _synchPost at 0x81d542c>] </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="__hook_pre_twisted_python_logfile_LogFile_rotate__"></a>
<h3>__hook_pre_twisted_python_logfile_LogFile_rotate__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="[<function _synchPre at 0x823753c>]"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
[<function _synchPre at 0x823753c>] </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="__hook_pre_twisted_python_logfile_LogFile_write__"></a>
<h3>__hook_pre_twisted_python_logfile_LogFile_write__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="[<function _synchPre at 0x823753c>]"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
[<function _synchPre at 0x823753c>] </pre>
</td></tr></table></dd>
</span> </dl>
</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:08:58 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>