<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>log4cpp: log4cpp::RollingFileAppender Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespacelog4cpp.html">log4cpp</a>::<a class="el" href="classlog4cpp_1_1RollingFileAppender.html">RollingFileAppender</a> </div> </div> <div class="contents"> <h1>log4cpp::RollingFileAppender Class Reference</h1><!-- doxytag: class="log4cpp::RollingFileAppender" --><!-- doxytag: inherits="log4cpp::FileAppender" --><a class="el" href="classlog4cpp_1_1RollingFileAppender.html" title="RollingFileAppender is a FileAppender that rolls over the logfile once it has reached...">RollingFileAppender</a> is a <a class="el" href="classlog4cpp_1_1FileAppender.html">FileAppender</a> that rolls over the logfile once it has reached a certain size limit. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="RollingFileAppender_8hh_source.html">RollingFileAppender.hh</a>></code> <p> <div class="dynheader"> Inheritance diagram for log4cpp::RollingFileAppender:</div> <div class="dynsection"> <p><center><img src="classlog4cpp_1_1RollingFileAppender.png" usemap="#log4cpp::RollingFileAppender_map" border="0" alt=""></center> <map name="log4cpp::RollingFileAppender_map"> <area href="classlog4cpp_1_1FileAppender.html" alt="log4cpp::FileAppender" shape="rect" coords="0,168,178,192"> <area href="classlog4cpp_1_1LayoutAppender.html" alt="log4cpp::LayoutAppender" shape="rect" coords="0,112,178,136"> <area href="classlog4cpp_1_1AppenderSkeleton.html" alt="log4cpp::AppenderSkeleton" shape="rect" coords="0,56,178,80"> <area href="classlog4cpp_1_1Appender.html" alt="log4cpp::Appender" shape="rect" coords="0,0,178,24"> </map> </div> <p> <a href="classlog4cpp_1_1RollingFileAppender-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1RollingFileAppender.html#d0a3a00ceb678b0c30287d1139358472">RollingFileAppender</a> (const std::string &name, const std::string &fileName, size_t maxFileSize=10 *1024 *1024, unsigned int maxBackupIndex=1, bool append=true, mode_t mode=00644)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1RollingFileAppender.html#cc5c64f822c2e322466b3df040e09cdd">setMaxBackupIndex</a> (unsigned int maxBackups)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1RollingFileAppender.html#3f0d4d75f7786247321973924de39b6e">getMaxBackupIndex</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1RollingFileAppender.html#3544130588d9493c9505ece5905fdea8">setMaximumFileSize</a> (size_t maxFileSize)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1RollingFileAppender.html#a8ddebdade7c1b0e88a9a48d7584e47f">getMaxFileSize</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1RollingFileAppender.html#2011afcabc04f1843017b4a39a7bbd3d">rollOver</a> ()</td></tr> <tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1RollingFileAppender.html#5f12f7246967c746cf70b89022fb5cbb">_append</a> (const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> &event)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Log in <a class="el" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements.">Appender</a> specific way. <a href="#5f12f7246967c746cf70b89022fb5cbb"></a><br></td></tr> <tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1RollingFileAppender.html#ab525e445cb30a7d823e9b3f3ccdd06b">_maxBackupIndex</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1RollingFileAppender.html#0f2b8a67731eec6848f37f6287169a21">_maxFileSize</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <a class="el" href="classlog4cpp_1_1RollingFileAppender.html" title="RollingFileAppender is a FileAppender that rolls over the logfile once it has reached...">RollingFileAppender</a> is a <a class="el" href="classlog4cpp_1_1FileAppender.html">FileAppender</a> that rolls over the logfile once it has reached a certain size limit. <p> <dl class="since" compact><dt><b>Since:</b></dt><dd>0.3.1 </dd></dl> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="d0a3a00ceb678b0c30287d1139358472"></a><!-- doxytag: member="log4cpp::RollingFileAppender::RollingFileAppender" ref="d0a3a00ceb678b0c30287d1139358472" args="(const std::string &name, const std::string &fileName, size_t maxFileSize=10 *1024 *1024, unsigned int maxBackupIndex=1, bool append=true, mode_t mode=00644)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">log4cpp::RollingFileAppender::RollingFileAppender </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>name</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>fileName</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">size_t </td> <td class="paramname"> <em>maxFileSize</em> = <code>10*1024*1024</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">unsigned int </td> <td class="paramname"> <em>maxBackupIndex</em> = <code>1</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>append</em> = <code>true</code>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">mode_t </td> <td class="paramname"> <em>mode</em> = <code>00644</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="5f12f7246967c746cf70b89022fb5cbb"></a><!-- doxytag: member="log4cpp::RollingFileAppender::_append" ref="5f12f7246967c746cf70b89022fb5cbb" args="(const LoggingEvent &event)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void log4cpp::RollingFileAppender::_append </td> <td>(</td> <td class="paramtype">const <a class="el" href="structlog4cpp_1_1LoggingEvent.html">LoggingEvent</a> & </td> <td class="paramname"> <em>event</em> </td> <td> ) </td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Log in <a class="el" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements.">Appender</a> specific way. <p> Subclasses of <a class="el" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements.">Appender</a> should implement this method to perform actual logging. <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The <a class="el" href="structlog4cpp_1_1LoggingEvent.html" title="The internal representation of logging events.">LoggingEvent</a> to log. </td></tr> </table> </dl> <p>Reimplemented from <a class="el" href="classlog4cpp_1_1FileAppender.html#16922adcd64137ca9d87ab2b2f250d0d">log4cpp::FileAppender</a>.</p> </div> </div><p> <a class="anchor" name="3f0d4d75f7786247321973924de39b6e"></a><!-- doxytag: member="log4cpp::RollingFileAppender::getMaxBackupIndex" ref="3f0d4d75f7786247321973924de39b6e" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int log4cpp::RollingFileAppender::getMaxBackupIndex </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="a8ddebdade7c1b0e88a9a48d7584e47f"></a><!-- doxytag: member="log4cpp::RollingFileAppender::getMaxFileSize" ref="a8ddebdade7c1b0e88a9a48d7584e47f" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t log4cpp::RollingFileAppender::getMaxFileSize </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="2011afcabc04f1843017b4a39a7bbd3d"></a><!-- doxytag: member="log4cpp::RollingFileAppender::rollOver" ref="2011afcabc04f1843017b4a39a7bbd3d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void log4cpp::RollingFileAppender::rollOver </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="cc5c64f822c2e322466b3df040e09cdd"></a><!-- doxytag: member="log4cpp::RollingFileAppender::setMaxBackupIndex" ref="cc5c64f822c2e322466b3df040e09cdd" args="(unsigned int maxBackups)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void log4cpp::RollingFileAppender::setMaxBackupIndex </td> <td>(</td> <td class="paramtype">unsigned int </td> <td class="paramname"> <em>maxBackups</em> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="3544130588d9493c9505ece5905fdea8"></a><!-- doxytag: member="log4cpp::RollingFileAppender::setMaximumFileSize" ref="3544130588d9493c9505ece5905fdea8" args="(size_t maxFileSize)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void log4cpp::RollingFileAppender::setMaximumFileSize </td> <td>(</td> <td class="paramtype">size_t </td> <td class="paramname"> <em>maxFileSize</em> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="ab525e445cb30a7d823e9b3f3ccdd06b"></a><!-- doxytag: member="log4cpp::RollingFileAppender::_maxBackupIndex" ref="ab525e445cb30a7d823e9b3f3ccdd06b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned int <a class="el" href="classlog4cpp_1_1RollingFileAppender.html#ab525e445cb30a7d823e9b3f3ccdd06b">log4cpp::RollingFileAppender::_maxBackupIndex</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="0f2b8a67731eec6848f37f6287169a21"></a><!-- doxytag: member="log4cpp::RollingFileAppender::_maxFileSize" ref="0f2b8a67731eec6848f37f6287169a21" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">size_t <a class="el" href="classlog4cpp_1_1RollingFileAppender.html#0f2b8a67731eec6848f37f6287169a21">log4cpp::RollingFileAppender::_maxFileSize</a><code> [protected]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="RollingFileAppender_8hh_source.html">RollingFileAppender.hh</a><li><a class="el" href="RollingFileAppender_8cpp.html">RollingFileAppender.cpp</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Sun Jul 26 19:34:50 2009 for log4cpp by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> </body> </html>