<!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::FileAppender 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_1FileAppender.html">FileAppender</a>
</div>
</div>
<div class="contents">
<h1>log4cpp::FileAppender Class Reference</h1><!-- doxytag: class="log4cpp::FileAppender" --><!-- doxytag: inherits="log4cpp::LayoutAppender" --><code>#include <<a class="el" href="FileAppender_8hh_source.html">FileAppender.hh</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for log4cpp::FileAppender:</div>
<div class="dynsection">
<p><center><img src="classlog4cpp_1_1FileAppender.png" usemap="#log4cpp::FileAppender_map" border="0" alt=""></center>
<map name="log4cpp::FileAppender_map">
<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">
<area href="classlog4cpp_1_1RollingFileAppender.html" alt="log4cpp::RollingFileAppender" shape="rect" coords="0,224,178,248">
</map>
</div>
<p>
<a href="classlog4cpp_1_1FileAppender-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_1FileAppender.html#0b2eef203507c312d318d8873968c9a5">FileAppender</a> (const std::string &name, const std::string &fileName, bool append=true, mode_t mode=00644)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classlog4cpp_1_1FileAppender.html">FileAppender</a>. <a href="#0b2eef203507c312d318d8873968c9a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1FileAppender.html#dc0e90778a385193f6efc4f0582e197f">FileAppender</a> (const std::string &name, int fd)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classlog4cpp_1_1FileAppender.html">FileAppender</a> to an already open file descriptor. <a href="#dc0e90778a385193f6efc4f0582e197f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1FileAppender.html#921423fbb52bedea9613f8750663ce12">~FileAppender</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1FileAppender.html#dc5a6091d98e5aee1cb990e9fedaf946">reopen</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reopens the logfile. <a href="#dc5a6091d98e5aee1cb990e9fedaf946"></a><br></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_1FileAppender.html#b76d4e1ff38513f30e83d19df6069e99">close</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the logfile. <a href="#b76d4e1ff38513f30e83d19df6069e99"></a><br></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_1FileAppender.html#a4f707ca21048b3b036585eca7d8403a">setAppend</a> (bool append)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the append vs truncate flag. <a href="#a4f707ca21048b3b036585eca7d8403a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1FileAppender.html#866b06b4219d216693585118be2c4711">getAppend</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the value of the 'append' option. <a href="#866b06b4219d216693585118be2c4711"></a><br></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_1FileAppender.html#a9bc965f1fcf173c2834e3bdf58d0c01">setMode</a> (mode_t mode)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the file open mode. <a href="#a9bc965f1fcf173c2834e3bdf58d0c01"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual mode_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1FileAppender.html#3b652da4d169cc6cfb50968daf8762bd">getMode</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the file open mode. <a href="#3b652da4d169cc6cfb50968daf8762bd"></a><br></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_1FileAppender.html#16922adcd64137ca9d87ab2b2f250d0d">_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="#16922adcd64137ca9d87ab2b2f250d0d"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1FileAppender.html#160529fae6d231eb7e91464cfa3f409d">_fileName</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1FileAppender.html#29a60724e02e279cda4832b89daa1e7f">_fd</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1FileAppender.html#a06f853a3012f378682d9e170490064c">_flags</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">mode_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cpp_1_1FileAppender.html#1fabbdec586ab860a9969e0f6a483e78">_mode</a></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="0b2eef203507c312d318d8873968c9a5"></a><!-- doxytag: member="log4cpp::FileAppender::FileAppender" ref="0b2eef203507c312d318d8873968c9a5" args="(const std::string &name, const std::string &fileName, bool append=true, mode_t mode=00644)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">log4cpp::FileAppender::FileAppender </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">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>
Constructs a <a class="el" href="classlog4cpp_1_1FileAppender.html">FileAppender</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the <a class="el" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements.">Appender</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fileName</em> </td><td>the name of the file to which the <a class="el" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements.">Appender</a> has to log. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>append</em> </td><td>whether the <a class="el" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements.">Appender</a> has to truncate the file or just append to it if it already exists. Defaults to 'true'. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>file mode to open the logfile with. Defaults to 00644. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="dc0e90778a385193f6efc4f0582e197f"></a><!-- doxytag: member="log4cpp::FileAppender::FileAppender" ref="dc0e90778a385193f6efc4f0582e197f" args="(const std::string &name, int fd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">log4cpp::FileAppender::FileAppender </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">int </td>
<td class="paramname"> <em>fd</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructs a <a class="el" href="classlog4cpp_1_1FileAppender.html">FileAppender</a> to an already open file descriptor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>the name of the <a class="el" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements.">Appender</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>fd</em> </td><td>the file descriptor to which the <a class="el" href="classlog4cpp_1_1Appender.html" title="Implement this interface for your own strategies for printing log statements.">Appender</a> has to log. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="921423fbb52bedea9613f8750663ce12"></a><!-- doxytag: member="log4cpp::FileAppender::~FileAppender" ref="921423fbb52bedea9613f8750663ce12" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">log4cpp::FileAppender::~FileAppender </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="16922adcd64137ca9d87ab2b2f250d0d"></a><!-- doxytag: member="log4cpp::FileAppender::_append" ref="16922adcd64137ca9d87ab2b2f250d0d" args="(const LoggingEvent &event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void log4cpp::FileAppender::_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>Implements <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#643fb2614192ea09b502a3feb27abe66">log4cpp::AppenderSkeleton</a>.</p>
<p>Reimplemented in <a class="el" href="classlog4cpp_1_1RollingFileAppender.html#5f12f7246967c746cf70b89022fb5cbb">log4cpp::RollingFileAppender</a>.</p>
</div>
</div><p>
<a class="anchor" name="b76d4e1ff38513f30e83d19df6069e99"></a><!-- doxytag: member="log4cpp::FileAppender::close" ref="b76d4e1ff38513f30e83d19df6069e99" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void log4cpp::FileAppender::close </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Closes the logfile.
<p>
<p>Implements <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#c62f94c6692fd146fcf37455d3e73439">log4cpp::AppenderSkeleton</a>.</p>
</div>
</div><p>
<a class="anchor" name="866b06b4219d216693585118be2c4711"></a><!-- doxytag: member="log4cpp::FileAppender::getAppend" ref="866b06b4219d216693585118be2c4711" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool log4cpp::FileAppender::getAppend </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the value of the 'append' option.
<p>
</div>
</div><p>
<a class="anchor" name="3b652da4d169cc6cfb50968daf8762bd"></a><!-- doxytag: member="log4cpp::FileAppender::getMode" ref="3b652da4d169cc6cfb50968daf8762bd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mode_t log4cpp::FileAppender::getMode </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the file open mode.
<p>
</div>
</div><p>
<a class="anchor" name="dc5a6091d98e5aee1cb990e9fedaf946"></a><!-- doxytag: member="log4cpp::FileAppender::reopen" ref="dc5a6091d98e5aee1cb990e9fedaf946" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool log4cpp::FileAppender::reopen </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reopens the logfile.
<p>
This can be useful for logfiles that are rotated externally, e.g. by logrotate. This method is a NOOP for FileAppenders that have been constructed with a file descriptor. <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the reopen succeeded. </dd></dl>
<p>Reimplemented from <a class="el" href="classlog4cpp_1_1AppenderSkeleton.html#1f61281caac83409db298b681635e029">log4cpp::AppenderSkeleton</a>.</p>
</div>
</div><p>
<a class="anchor" name="a4f707ca21048b3b036585eca7d8403a"></a><!-- doxytag: member="log4cpp::FileAppender::setAppend" ref="a4f707ca21048b3b036585eca7d8403a" args="(bool append)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void log4cpp::FileAppender::setAppend </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>append</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the append vs truncate flag.
<p>
NB. currently the <a class="el" href="classlog4cpp_1_1FileAppender.html">FileAppender</a> opens the logfile in the constructor. Therefore this method is too late to influence the first file opening. We'll need something similar to log4j's activateOptions(). <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>append</em> </td><td>false to truncate, true to append </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a9bc965f1fcf173c2834e3bdf58d0c01"></a><!-- doxytag: member="log4cpp::FileAppender::setMode" ref="a9bc965f1fcf173c2834e3bdf58d0c01" args="(mode_t mode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void log4cpp::FileAppender::setMode </td>
<td>(</td>
<td class="paramtype">mode_t </td>
<td class="paramname"> <em>mode</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the file open mode.
<p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="29a60724e02e279cda4832b89daa1e7f"></a><!-- doxytag: member="log4cpp::FileAppender::_fd" ref="29a60724e02e279cda4832b89daa1e7f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classlog4cpp_1_1FileAppender.html#29a60724e02e279cda4832b89daa1e7f">log4cpp::FileAppender::_fd</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="160529fae6d231eb7e91464cfa3f409d"></a><!-- doxytag: member="log4cpp::FileAppender::_fileName" ref="160529fae6d231eb7e91464cfa3f409d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string <a class="el" href="classlog4cpp_1_1FileAppender.html#160529fae6d231eb7e91464cfa3f409d">log4cpp::FileAppender::_fileName</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="a06f853a3012f378682d9e170490064c"></a><!-- doxytag: member="log4cpp::FileAppender::_flags" ref="a06f853a3012f378682d9e170490064c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classlog4cpp_1_1FileAppender.html#a06f853a3012f378682d9e170490064c">log4cpp::FileAppender::_flags</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="1fabbdec586ab860a9969e0f6a483e78"></a><!-- doxytag: member="log4cpp::FileAppender::_mode" ref="1fabbdec586ab860a9969e0f6a483e78" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mode_t <a class="el" href="classlog4cpp_1_1FileAppender.html#1fabbdec586ab860a9969e0f6a483e78">log4cpp::FileAppender::_mode</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="FileAppender_8hh_source.html">FileAppender.hh</a><li><a class="el" href="FileAppender_8cpp.html">FileAppender.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>
