| <html> |
| <head> |
| <title> |
| log4cxx - Documentation |
| </title> |
| <link href="../css/doxygen.css" rel="stylesheet" type="text/css"/> |
| </head> |
| |
| <body bgcolor="#ffffff" text="#000000" link="#525D76"> |
| <!-- START Header table --> |
| <table border="0" cellspacing="0" width="90%"> |
| <!-- TOP IMAGE --> |
| <tr> |
| <td colspan="2"> |
| <a href="http://logging.apache.org"> |
| <img src="http://logging.apache.org/images/ls-logo.jpg" align="left" border="0"/> |
| </a> |
| </td> |
| |
| </tr> |
| </table> |
| <!-- END Header table --> |
| |
| <!-- START main table --> |
| <table id="main" border="0" width="90%" cellspacing="2" cellpadding="0"> |
| <tr><td colspan="2"> |
| <hr noshade="" size="1"/> |
| </td></tr> |
| |
| <tr> |
| <!-- LEFT SIDE NAVIGATION --> |
| <td id="navbar" valign="top"> |
| <!-- ============================================================ --> |
| <table id="navbar" border="0" cellspacing="0" cellpadding="0"> |
| <tr > |
| <td class="navbarHeader" nowrap="true"> |
| <strong>Apache</strong> |
| </td> |
| </tr> |
| <tr><td class="navbarItem"><small> <a href="http://www.apache.org">Apache Home</a> |
| </small></td></tr> |
| <tr><td class="navbarItem"><small> <a href="http://logging.apache.org/">Logging Services</a> |
| </small></td></tr> |
| <tr > |
| <td class="navbarHeader" nowrap="true"> |
| <strong>log4cxx project</strong> |
| </td> |
| </tr> |
| <tr><td class="navbarItem"><small> <a href="../index.html">About</a> |
| </small></td></tr> |
| <tr><td class="navbarItem"><small> <a href="../news.html">News</a> |
| </small></td></tr> |
| <tr><td class="navbarItem"><small> <a href="../team.html">Team</a> |
| </small></td></tr> |
| <tr><td class="navbarItem"><small> <a href="../manual/index.html">Documentation</a> |
| </small></td></tr> |
| <tr><td class="navbarItem"><small> <a href="../performance.html">Performance</a> |
| </small></td></tr> |
| <tr><td class="navbarItem"><small> <a href="../download.html">Download</a> |
| </small></td></tr> |
| </table> |
| |
| </td> |
| <td id="mainContents" align="left" valign="top"> |
| <hr> |
| <!-- Generated by Doxygen 1.3.5 --> |
| <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
| <h1>WriterAppender Class Reference</h1>Inheritance diagram for WriterAppender:<p><center><img src="classlog4cxx_1_1WriterAppender__inherit__graph.png" border="0" usemap="#WriterAppender__inherit__map" alt="Inheritance graph"></center> |
| <map name="WriterAppender__inherit__map"> |
| <area href="classlog4cxx_1_1ConsoleAppender.html" shape="rect" coords="7,392,124,416" alt=""> |
| <area href="classlog4cxx_1_1FileAppender.html" shape="rect" coords="148,392,241,416" alt=""> |
| <area href="classlog4cxx_1_1AppenderSkeleton.html" shape="rect" coords="68,243,190,266" alt=""> |
| <area href="classlog4cxx_1_1Appender.html" shape="rect" coords="45,168,117,192" alt=""> |
| <area href="classlog4cxx_1_1spi_1_1OptionHandler.html" shape="rect" coords="39,93,135,117" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="105,19,156,43" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1ObjectImpl.html" shape="rect" coords="141,168,216,192" alt=""> |
| <area href="classlog4cxx_1_1DailyRollingFileAppender.html" shape="rect" coords="27,466,189,490" alt=""> |
| <area href="classlog4cxx_1_1RollingFileAppender.html" shape="rect" coords="213,466,346,490" alt=""> |
| </map> |
| <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for WriterAppender:<p><center><img src="classlog4cxx_1_1WriterAppender__coll__graph.png" border="0" usemap="#WriterAppender__coll__map" alt="Collaboration graph"></center> |
| <map name="WriterAppender__coll__map"> |
| <area href="classlog4cxx_1_1AppenderSkeleton.html" shape="rect" coords="69,346,192,370" alt=""> |
| <area href="classlog4cxx_1_1Appender.html" shape="rect" coords="21,197,93,221" alt=""> |
| <area href="classlog4cxx_1_1spi_1_1OptionHandler.html" shape="rect" coords="7,96,103,120" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="80,18,131,42" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1ObjectImpl.html" shape="rect" coords="100,146,174,170" alt=""> |
| <area href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html" shape="rect" coords="168,197,240,221" alt=""> |
| </map> |
| <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classlog4cxx_1_1WriterAppender-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="classlog4cxx_1_1WriterAppender.html#a0">WriterAppender</a> ()</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1WriterAppender.html#a1">WriterAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">LayoutPtr</a> &<a class="el" href="classlog4cxx_1_1AppenderSkeleton.html#p0">layout</a>, ostream *<a class="el" href="classlog4cxx_1_1WriterAppender.html#p2">os</a>)</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1WriterAppender.html#a3">setImmediateFlush</a> (bool value)</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1WriterAppender.html#a4">getImmediateFlush</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="classlog4cxx_1_1WriterAppender.html#a5">append</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">spi::LoggingEventPtr</a> &event)</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1WriterAppender.html#a6">close</a> ()</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1WriterAppender.html#a9">requiresLayout</a> () const </td></tr> |
| |
| <tr><td colspan=2><br><h2>Protected Member Functions</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1WriterAppender.html#b0">checkEntryConditions</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="classlog4cxx_1_1WriterAppender.html#b1">closeWriter</a> ()=0</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1WriterAppender.html#b2">subAppend</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">spi::LoggingEventPtr</a> &event)</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1WriterAppender.html#b3">reset</a> ()</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1WriterAppender.html#b4">writeFooter</a> ()</td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1WriterAppender.html#b5">writeHeader</a> ()</td></tr> |
| |
| <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> |
| <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1WriterAppender.html#p0">immediateFlush</a></td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>String </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1WriterAppender.html#p1">encoding</a></td></tr> |
| |
| <tr><td class="memItemLeft" nowrap align=right valign=top>ostream * </td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1WriterAppender.html#p2">os</a></td></tr> |
| |
| </table> |
| <hr><a name="_details"></a><h2>Detailed Description</h2> |
| <a class="el" href="classlog4cxx_1_1WriterAppender.html">WriterAppender</a> appends log events to a standard output stream (ostream or wostream) |
| <p> |
| <hr><h2>Constructor & Destructor Documentation</h2> |
| <a class="anchor" name="a0" doxytag="log4cxx::WriterAppender::WriterAppender" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> <a class="el" href="classlog4cxx_1_1WriterAppender.html">WriterAppender</a> </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| This default constructor does nothing. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a1" doxytag="log4cxx::WriterAppender::WriterAppender" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> <a class="el" href="classlog4cxx_1_1WriterAppender.html">WriterAppender</a> </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">LayoutPtr</a> & </td> |
| <td class="mdname" nowrap> <em>layout</em>, </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td></td> |
| <td class="md" nowrap>ostream * </td> |
| <td class="mdname" nowrap> <em>os</em></td> |
| </tr> |
| <tr> |
| <td></td> |
| <td class="md">) </td> |
| <td class="md" colspan="2"></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Instantiate a <a class="el" href="classlog4cxx_1_1WriterAppender.html">WriterAppender</a> and set the output destination to <code>os</code>. </td> |
| </tr> |
| </table> |
| <hr><h2>Member Function Documentation</h2> |
| <a class="anchor" name="a5" doxytag="log4cxx::WriterAppender::append" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void append </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">spi::LoggingEventPtr</a> & </td> |
| <td class="mdname1" valign="top" nowrap> <em>event</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| This method is called by the <a class="el" href="classlog4cxx_1_1AppenderSkeleton.html#a13">AppenderSkeleton::doAppend</a> method.<p> |
| If the output stream exists and is writable then write a log statement to the output stream. Otherwise, write a single warning message to <code>stderr</code>.<p> |
| The format of the output will depend on this appender's layout. |
| <p> |
| Implements <a class="el" href="classlog4cxx_1_1AppenderSkeleton.html#b0">AppenderSkeleton</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="b0" doxytag="log4cxx::WriterAppender::checkEntryConditions" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> bool checkEntryConditions </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const<code> [protected, virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| This method determines if there is a sense in attempting to append.<p> |
| It checks whether there is a set output target and also if there is a set layout. If these checks fail, then the boolean value <code>false</code> is returned. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a6" doxytag="log4cxx::WriterAppender::close" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void close </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Close this appender instance. The underlying stream or writer is also closed.<p> |
| Closed appenders cannot be reused. |
| <p> |
| Implements <a class="el" href="classlog4cxx_1_1Appender.html#a4">Appender</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="b1" doxytag="log4cxx::WriterAppender::closeWriter" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> virtual void closeWriter </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [protected, pure virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Close the underlying output stream. |
| <p> |
| Implemented in <a class="el" href="classlog4cxx_1_1ConsoleAppender.html#b0">ConsoleAppender</a>, and <a class="el" href="classlog4cxx_1_1FileAppender.html#b0">FileAppender</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a4" doxytag="log4cxx::WriterAppender::getImmediateFlush" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> bool getImmediateFlush </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const<code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Returns value of the <b>ImmediateFlush</b> option. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a9" doxytag="log4cxx::WriterAppender::requiresLayout" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> virtual bool requiresLayout </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap> const<code> [inline, virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| The <a class="el" href="classlog4cxx_1_1WriterAppender.html">WriterAppender</a> requires a layout. Hence, this method returns <code>true</code>. |
| <p> |
| Implements <a class="el" href="classlog4cxx_1_1Appender.html#a12">Appender</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="b3" doxytag="log4cxx::WriterAppender::reset" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void reset </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [protected, virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Clear internal references to the writer and other variables.<p> |
| Subclasses can override this method for an alternate closing behavior. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="a3" doxytag="log4cxx::WriterAppender::setImmediateFlush" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void setImmediateFlush </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">bool </td> |
| <td class="mdname1" valign="top" nowrap> <em>value</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [inline]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| If the <b>ImmediateFlush</b> option is set to <code>true</code>, the appender will flush at the end of each write. This is the default behavior. If the option is set to <code>false</code>, then the underlying stream can defer writing to physical medium to a later time.<p> |
| Avoiding the flush operation at the end of each append results in a performance gain of 10 to 20 percent. However, there is safety tradeoff involved in skipping flushing. Indeed, when flushing is skipped, then it is likely that the last few log events will not be recorded on disk when the application exits. This is a high price to pay even for a 20% performance gain. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="b2" doxytag="log4cxx::WriterAppender::subAppend" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void subAppend </td> |
| <td class="md" valign="top">( </td> |
| <td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">spi::LoggingEventPtr</a> & </td> |
| <td class="mdname1" valign="top" nowrap> <em>event</em> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [protected, virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Actual writing occurs here.<p> |
| Most subclasses of <code><a class="el" href="classlog4cxx_1_1WriterAppender.html">WriterAppender</a></code> will need to override this method. |
| <p> |
| Reimplemented in <a class="el" href="classlog4cxx_1_1DailyRollingFileAppender.html#b1">DailyRollingFileAppender</a>, and <a class="el" href="classlog4cxx_1_1RollingFileAppender.html#b0">RollingFileAppender</a>. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="b4" doxytag="log4cxx::WriterAppender::writeFooter" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void writeFooter </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [protected, virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Write a footer as produced by the embedded layout's <a class="el" href="classlog4cxx_1_1Layout.html#a4">Layout::appendFooter</a> method. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="b5" doxytag="log4cxx::WriterAppender::writeHeader" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> void writeHeader </td> |
| <td class="md" valign="top">( </td> |
| <td class="mdname1" valign="top" nowrap> </td> |
| <td class="md" valign="top"> ) </td> |
| <td class="md" nowrap><code> [protected, virtual]</code></td> |
| </tr> |
| |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Write a header as produced by the embedded layout's <a class="el" href="classlog4cxx_1_1Layout.html#a3">Layout::appendHeader</a> method. </td> |
| </tr> |
| </table> |
| <hr><h2>Member Data Documentation</h2> |
| <a class="anchor" name="p1" doxytag="log4cxx::WriterAppender::encoding" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> String <a class="el" href="classlog4cxx_1_1WriterAppender.html#p1">encoding</a><code> [protected]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| The encoding to use when opening an input stream. <p> |
| The <code>encoding</code> variable is set to <code>""</code> by default which results in the utilization of the system's default encoding. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="p0" doxytag="log4cxx::WriterAppender::immediateFlush" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> bool <a class="el" href="classlog4cxx_1_1WriterAppender.html#p0">immediateFlush</a><code> [protected]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| Immediate flush means that the underlying writer or output stream will be flushed at the end of each append operation. Immediate flush is slower but ensures that each append request is actually written. If <code>immediateFlush</code> is set to<p> |
| <code>false</code>, then there is a good chance that the last few logs events are not actually written to persistent media if and when the application crashes.<p> |
| The <code>immediateFlush</code> variable is set to <code>true</code> by default. </td> |
| </tr> |
| </table> |
| <a class="anchor" name="p2" doxytag="log4cxx::WriterAppender::os" ></a><p> |
| <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
| <tr> |
| <td class="mdRow"> |
| <table cellpadding="0" cellspacing="0" border="0"> |
| <tr> |
| <td class="md" nowrap valign="top"> ostream* <a class="el" href="classlog4cxx_1_1WriterAppender.html#p2">os</a><code> [protected]</code> |
| </table> |
| </td> |
| </tr> |
| </table> |
| <table cellspacing=5 cellpadding=0 border=0> |
| <tr> |
| <td> |
| |
| </td> |
| <td> |
| |
| <p> |
| This is the output stream where we will write to. </td> |
| </tr> |
| </table> |
| <hr>The documentation for this class was generated from the following files:<ul> |
| <li>writerappender.h<li>writerappender.cpp</ul> |
| |
| </td> |
| </tr> |
| |
| <!-- FOOTER --> |
| <tr><td colspan="2"> |
| <hr noshade="" size="1"/> |
| </td></tr> |
| <tr><td colspan="2"> |
| <div align="center"><font color="#525D76" size="-1"><em> |
| Copyright © 1999-2004, Apache Software Foundation |
| </em></font></div> |
| </td></tr> |
| </table> |
| <!-- END main table --> |
| </body> |
| </html> |
| <!-- end the processing --> |
