<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Apache log4cxx: OnlyOnceErrorHandler Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache log4cxx <span id="projectnumber">Version 0.10.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('classlog4cxx_1_1helpers_1_1_only_once_error_handler.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>OnlyOnceErrorHandler Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::helpers::OnlyOnceErrorHandler" --><!-- doxytag: inherits="log4cxx::spi::ErrorHandler,log4cxx::helpers::ObjectImpl" -->
<p>The <code><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html" title="The OnlyOnceErrorHandler implements log4cxx's default error handling policy which consists of emi...">OnlyOnceErrorHandler</a></code> implements log4cxx's default error handling policy which consists of emitting a message for the first error in an appender and ignoring all following errors.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1spi_1_1_error_handler.html">log4cxx::spi::ErrorHandler</a>, and <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">log4cxx::helpers::ObjectImpl</a>.</p>
<p><a href="classlog4cxx_1_1helpers_1_1_only_once_error_handler-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#af476c272541554f3113a50e07a8df7f9">OnlyOnceErrorHandler</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#a0198815940c2715c84b0e04828cf8dfa">addRef</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#a55c31efee1904916b999395fa4d46a24">releaseRef</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#ad71cb681f580c2dd0ac0b15c4c5cf979">setLogger</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> &logger)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Does not do anything. <a href="#ad71cb681f580c2dd0ac0b15c4c5cf979"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#aa3df68f8aae152299471992071e202f5">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &p)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">No options to activate. <a href="#aa3df68f8aae152299471992071e202f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#ac1d269357907e0809687a2bec962e1c8">setOption</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &option, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set <code>option</code> to <code>value</code>. <a href="#ac1d269357907e0809687a2bec962e1c8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#a9084c6c8c225845ed09867b730590514">error</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &message, const std::exception &e, int errorCode) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints the message and the stack trace of the exception on <code>System.err</code>. <a href="#a9084c6c8c225845ed09867b730590514"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#a24071234bd8fa94ccab51c6ac5e246c5">error</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &message, const std::exception &e, int errorCode, const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> &event) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints the message and the stack trace of the exception on <code>System.err</code>. <a href="#a24071234bd8fa94ccab51c6ac5e246c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#ad92a3ce84facc670863be59563d0603d">error</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &message) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print a the error message passed as parameter on <code>System.err</code>. <a href="#ad92a3ce84facc670863be59563d0603d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#a5d46275bd2a01b2102f4b03b294ec50b">setAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> &appender)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Does not do anything. <a href="#a5d46275bd2a01b2102f4b03b294ec50b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#af5ce3a0cde4a80c96cf5dee6389550b5">setBackupAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> &appender)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Does not do anything. <a href="#af5ce3a0cde4a80c96cf5dee6389550b5"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <code><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html" title="The OnlyOnceErrorHandler implements log4cxx's default error handling policy which consists of emi...">OnlyOnceErrorHandler</a></code> implements log4cxx's default error handling policy which consists of emitting a message for the first error in an appender and ignoring all following errors. </p>
<p>The error message is printed on <code>System.err</code>.</p>
<p>This policy aims at protecting an otherwise working application from being flooded with error messages when logging fails </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af476c272541554f3113a50e07a8df7f9"></a><!-- doxytag: member="log4cxx::helpers::OnlyOnceErrorHandler::OnlyOnceErrorHandler" ref="af476c272541554f3113a50e07a8df7f9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html">OnlyOnceErrorHandler</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa3df68f8aae152299471992071e202f5"></a><!-- doxytag: member="log4cxx::helpers::OnlyOnceErrorHandler::activateOptions" ref="aa3df68f8aae152299471992071e202f5" args="(log4cxx::helpers::Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void activateOptions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> & </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>No options to activate. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#af04d4bfbd66b46083b1aa042fdafbb06">OptionHandler</a>.</p>
</div>
</div>
<a class="anchor" id="a0198815940c2715c84b0e04828cf8dfa"></a><!-- doxytag: member="log4cxx::helpers::OnlyOnceErrorHandler::addRef" ref="a0198815940c2715c84b0e04828cf8dfa" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void addRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#a0198815940c2715c84b0e04828cf8dfa">ObjectImpl</a>.</p>
</div>
</div>
<a class="anchor" id="ad92a3ce84facc670863be59563d0603d"></a><!-- doxytag: member="log4cxx::helpers::OnlyOnceErrorHandler::error" ref="ad92a3ce84facc670863be59563d0603d" args="(const LogString &message) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void error </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>message</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print a the error message passed as parameter on <code>System.err</code>. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_error_handler.html#a390324c11808d0cd4fee6c3967932f27">ErrorHandler</a>.</p>
</div>
</div>
<a class="anchor" id="a9084c6c8c225845ed09867b730590514"></a><!-- doxytag: member="log4cxx::helpers::OnlyOnceErrorHandler::error" ref="a9084c6c8c225845ed09867b730590514" args="(const LogString &message, const std::exception &e, int errorCode) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void error </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::exception & </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>errorCode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prints the message and the stack trace of the exception on <code>System.err</code>. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_error_handler.html#a20b213d025014be558dfab7e11652825">ErrorHandler</a>.</p>
</div>
</div>
<a class="anchor" id="a24071234bd8fa94ccab51c6ac5e246c5"></a><!-- doxytag: member="log4cxx::helpers::OnlyOnceErrorHandler::error" ref="a24071234bd8fa94ccab51c6ac5e246c5" args="(const LogString &message, const std::exception &e, int errorCode, const spi::LoggingEventPtr &event) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void error </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>message</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::exception & </td>
<td class="paramname"><em>e</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>errorCode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> & </td>
<td class="paramname"><em>event</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Prints the message and the stack trace of the exception on <code>System.err</code>. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_error_handler.html#ab087032b921fcef1735256049d38f0c1">ErrorHandler</a>.</p>
</div>
</div>
<a class="anchor" id="a55c31efee1904916b999395fa4d46a24"></a><!-- doxytag: member="log4cxx::helpers::OnlyOnceErrorHandler::releaseRef" ref="a55c31efee1904916b999395fa4d46a24" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void releaseRef </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html#a55c31efee1904916b999395fa4d46a24">ObjectImpl</a>.</p>
</div>
</div>
<a class="anchor" id="a5d46275bd2a01b2102f4b03b294ec50b"></a><!-- doxytag: member="log4cxx::helpers::OnlyOnceErrorHandler::setAppender" ref="a5d46275bd2a01b2102f4b03b294ec50b" args="(const AppenderPtr &appender)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setAppender </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> & </td>
<td class="paramname"><em>appender</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Does not do anything. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_error_handler.html#abf38035eedf752b85b9ffdcf414edd64">ErrorHandler</a>.</p>
</div>
</div>
<a class="anchor" id="af5ce3a0cde4a80c96cf5dee6389550b5"></a><!-- doxytag: member="log4cxx::helpers::OnlyOnceErrorHandler::setBackupAppender" ref="af5ce3a0cde4a80c96cf5dee6389550b5" args="(const AppenderPtr &appender)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setBackupAppender </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> & </td>
<td class="paramname"><em>appender</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Does not do anything. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_error_handler.html#abc2bb91894f25f42d8e1a429c8bec2bc">ErrorHandler</a>.</p>
</div>
</div>
<a class="anchor" id="ad71cb681f580c2dd0ac0b15c4c5cf979"></a><!-- doxytag: member="log4cxx::helpers::OnlyOnceErrorHandler::setLogger" ref="ad71cb681f580c2dd0ac0b15c4c5cf979" args="(const LoggerPtr &logger)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setLogger </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> & </td>
<td class="paramname"><em>logger</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Does not do anything. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_error_handler.html#a657c680e0246d95168aecbe4d299822b">ErrorHandler</a>.</p>
</div>
</div>
<a class="anchor" id="ac1d269357907e0809687a2bec962e1c8"></a><!-- doxytag: member="log4cxx::helpers::OnlyOnceErrorHandler::setOption" ref="ac1d269357907e0809687a2bec962e1c8" args="(const LogString &option, const LogString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setOption </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set <code>option</code> to <code>value</code>. </p>
<p>The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when <a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#aa3df68f8aae152299471992071e202f5" title="No options to activate.">activateOptions</a> is called. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#a8f2ae2ded63f80c627269c99b20c19ee">OptionHandler</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="onlyonceerrorhandler_8h.html">onlyonceerrorhandler.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelog4cxx.html">log4cxx</a> </li>
<li class="navelem"><a class="el" href="namespacelog4cxx_1_1helpers.html">helpers</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html">OnlyOnceErrorHandler</a> </li>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
</BODY>
</HTML>
