Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / html / python / lib / node348.html
CommitLineData
920dae64
AT
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4<link rel="STYLESHEET" href="lib.css" type='text/css' />
5<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
6<link rel='start' href='../index.html' title='Python Documentation Index' />
7<link rel="first" href="lib.html" title='Python Library Reference' />
8<link rel='contents' href='contents.html' title="Contents" />
9<link rel='index' href='genindex.html' title='Index' />
10<link rel='last' href='about.html' title='About this document...' />
11<link rel='help' href='about.html' title='About this document...' />
12<link rel="next" href="node349.html" />
13<link rel="prev" href="node347.html" />
14<link rel="parent" href="node345.html" />
15<link rel="next" href="node349.html" />
16<meta name='aesop' content='information' />
17<title>6.29.5.3 RotatingFileHandler</title>
18</head>
19<body>
20<DIV CLASS="navigation">
21<div id='top-navigation-panel' xml:id='top-navigation-panel'>
22<table align="center" width="100%" cellpadding="0" cellspacing="2">
23<tr>
24<td class='online-navigation'><a rel="prev" title="6.29.5.2 FileHandler"
25 href="node347.html"><img src='../icons/previous.png'
26 border='0' height='32' alt='Previous Page' width='32' /></A></td>
27<td class='online-navigation'><a rel="parent" title="6.29.5 Handler Objects"
28 href="node345.html"><img src='../icons/up.png'
29 border='0' height='32' alt='Up One Level' width='32' /></A></td>
30<td class='online-navigation'><a rel="next" title="6.29.5.4 TimedRotatingFileHandler"
31 href="node349.html"><img src='../icons/next.png'
32 border='0' height='32' alt='Next Page' width='32' /></A></td>
33<td align="center" width="100%">Python Library Reference</td>
34<td class='online-navigation'><a rel="contents" title="Table of Contents"
35 href="contents.html"><img src='../icons/contents.png'
36 border='0' height='32' alt='Contents' width='32' /></A></td>
37<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
38 border='0' height='32' alt='Module Index' width='32' /></a></td>
39<td class='online-navigation'><a rel="index" title="Index"
40 href="genindex.html"><img src='../icons/index.png'
41 border='0' height='32' alt='Index' width='32' /></A></td>
42</tr></table>
43<div class='online-navigation'>
44<b class="navlabel">Previous:</b>
45<a class="sectref" rel="prev" href="node347.html">6.29.5.2 FileHandler</A>
46<b class="navlabel">Up:</b>
47<a class="sectref" rel="parent" href="node345.html">6.29.5 Handler Objects</A>
48<b class="navlabel">Next:</b>
49<a class="sectref" rel="next" href="node349.html">6.29.5.4 TimedRotatingFileHandler</A>
50</div>
51<hr /></div>
52</DIV>
53<!--End of Navigation Panel-->
54
55<H3><A NAME="SECTION0082953000000000000000">
566.29.5.3 RotatingFileHandler</A>
57</H3>
58
59<P>
60The <tt class="class">RotatingFileHandler</tt> class supports rotation of disk log files.
61
62<P>
63<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
64 <td><nobr><b><span class="typelabel">class</span>&nbsp;<tt id='l2h-2513' xml:id='l2h-2513' class="class">RotatingFileHandler</tt></b>(</nobr></td>
65 <td><var>filename</var><big>[</big><var>, mode</var><big>[</big><var>,
66 maxBytes</var><big>[</big><var>, backupCount</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt>
67<dd>
68Returns a new instance of the <tt class="class">RotatingFileHandler</tt> class. The
69specified file is opened and used as the stream for logging. If
70<var>mode</var> is not specified, <code>'a'</code> is used. By default, the
71file grows indefinitely.
72
73<P>
74You can use the <var>maxBytes</var> and
75<var>backupCount</var> values to allow the file to <i class="dfn">rollover</i> at a
76predetermined size. When the size is about to be exceeded, the file is
77closed and a new file is silently opened for output. Rollover occurs
78whenever the current log file is nearly <var>maxBytes</var> in length; if
79<var>maxBytes</var> is zero, rollover never occurs. If <var>backupCount</var>
80is non-zero, the system will save old log files by appending the
81extensions ".1", ".2" etc., to the filename. For example, with
82a <var>backupCount</var> of 5 and a base file name of
83<span class="file">app.log</span>, you would get <span class="file">app.log</span>,
84<span class="file">app.log.1</span>, <span class="file">app.log.2</span>, up to <span class="file">app.log.5</span>. The file being
85written to is always <span class="file">app.log</span>. When this file is filled, it is
86closed and renamed to <span class="file">app.log.1</span>, and if files <span class="file">app.log.1</span>,
87<span class="file">app.log.2</span>, etc. exist, then they are renamed to <span class="file">app.log.2</span>,
88<span class="file">app.log.3</span> etc. respectively.
89</dl>
90
91<P>
92<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
93 <td><nobr><b><tt id='l2h-2514' xml:id='l2h-2514' class="method">doRollover</tt></b>(</nobr></td>
94 <td><var></var>)</td></tr></table></dt>
95<dd>
96Does a rollover, as described above.
97</dl>
98
99<P>
100<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
101 <td><nobr><b><tt id='l2h-2515' xml:id='l2h-2515' class="method">emit</tt></b>(</nobr></td>
102 <td><var>record</var>)</td></tr></table></dt>
103<dd>
104Outputs the record to the file, catering for rollover as described previously.
105</dl>
106
107<P>
108
109<DIV CLASS="navigation">
110<div class='online-navigation'>
111<p></p><hr />
112<table align="center" width="100%" cellpadding="0" cellspacing="2">
113<tr>
114<td class='online-navigation'><a rel="prev" title="6.29.5.2 FileHandler"
115 href="node347.html"><img src='../icons/previous.png'
116 border='0' height='32' alt='Previous Page' width='32' /></A></td>
117<td class='online-navigation'><a rel="parent" title="6.29.5 Handler Objects"
118 href="node345.html"><img src='../icons/up.png'
119 border='0' height='32' alt='Up One Level' width='32' /></A></td>
120<td class='online-navigation'><a rel="next" title="6.29.5.4 TimedRotatingFileHandler"
121 href="node349.html"><img src='../icons/next.png'
122 border='0' height='32' alt='Next Page' width='32' /></A></td>
123<td align="center" width="100%">Python Library Reference</td>
124<td class='online-navigation'><a rel="contents" title="Table of Contents"
125 href="contents.html"><img src='../icons/contents.png'
126 border='0' height='32' alt='Contents' width='32' /></A></td>
127<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
128 border='0' height='32' alt='Module Index' width='32' /></a></td>
129<td class='online-navigation'><a rel="index" title="Index"
130 href="genindex.html"><img src='../icons/index.png'
131 border='0' height='32' alt='Index' width='32' /></A></td>
132</tr></table>
133<div class='online-navigation'>
134<b class="navlabel">Previous:</b>
135<a class="sectref" rel="prev" href="node347.html">6.29.5.2 FileHandler</A>
136<b class="navlabel">Up:</b>
137<a class="sectref" rel="parent" href="node345.html">6.29.5 Handler Objects</A>
138<b class="navlabel">Next:</b>
139<a class="sectref" rel="next" href="node349.html">6.29.5.4 TimedRotatingFileHandler</A>
140</div>
141</div>
142<hr />
143<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
144</DIV>
145<!--End of Navigation Panel-->
146<ADDRESS>
147See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
148</ADDRESS>
149</BODY>
150</HTML>