1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!--
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.
--><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Apache log4cxx: ErrorHandler Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="main.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 id="current"><a href="classes.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="classes.html"><span>Alphabetical List</span></a></li>
<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="nav">
<a class="el" href="namespacelog4cxx.html">log4cxx</a>::<a class="el" href="namespacelog4cxx_1_1spi.html">spi</a>::<a class="el" href="classlog4cxx_1_1spi_1_1_error_handler.html">ErrorHandler</a></div>
<h1>ErrorHandler Class Reference</h1><!-- doxytag: class="log4cxx::spi::ErrorHandler" --><!-- doxytag: inherits="log4cxx::spi::OptionHandler" -->Inherits <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html">OptionHandler</a>.
<p>
Inherited by <a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html">OnlyOnceErrorHandler</a><code> [virtual]</code>, and <a class="el" href="classlog4cxx_1_1varia_1_1_fallback_error_handler.html">FallbackErrorHandler</a><code> [virtual]</code>.
<p>
<a href="classlog4cxx_1_1spi_1_1_error_handler-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Appenders may delegate their error handling to <code>ErrorHandlers</code>.
<p>
Error handling is a particularly tedious to get right because by definition errors are hard to predict and to reproduce.<p>
Please take the time to contact the author in case you discover that errors are not properly handled. You are most welcome to suggest new error handling policies or criticize existing policies.
<p>
<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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_error_handler.html#70e018e3f27ead8d955acd70e0e11737">~ErrorHandler</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_1spi_1_1_error_handler.html#657c680e0246d95168aecbe4d299822b">setLogger</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> &logger)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a reference to a logger to which the failing appender might be attached to. <a href="#657c680e0246d95168aecbe4d299822b"></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="classlog4cxx_1_1spi_1_1_error_handler.html#20b213d025014be558dfab7e11652825">error</a> (const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &message, const std::exception &e, int errorCode) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Equivalent to the error(const String&, <a class="el" href="classlog4cxx_1_1helpers_1_1_exception.html">helpers::Exception</a>&, int, <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">spi::LoggingEvent</a>&) with the the event parameteter set to null. <a href="#20b213d025014be558dfab7e11652825"></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="classlog4cxx_1_1spi_1_1_error_handler.html#390324c11808d0cd4fee6c3967932f27">error</a> (const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &message) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is normally used to just print the error message passed as a parameter. <a href="#390324c11808d0cd4fee6c3967932f27"></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="classlog4cxx_1_1spi_1_1_error_handler.html#b087032b921fcef1735256049d38f0c1">error</a> (const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &message, const std::exception &e, int errorCode, const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggingEventPtr</a> &event) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method is invoked to handle the error. <a href="#b087032b921fcef1735256049d38f0c1"></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="classlog4cxx_1_1spi_1_1_error_handler.html#bf38035eedf752b85b9ffdcf414edd64">setAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> &appender)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the appender for which errors are handled. <a href="#bf38035eedf752b85b9ffdcf414edd64"></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="classlog4cxx_1_1spi_1_1_error_handler.html#bc2bb91894f25f42d8e1a429c8bec2bc">setBackupAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> &appender)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the appender to fallback upon in case of failure. <a href="#bc2bb91894f25f42d8e1a429c8bec2bc"></a><br></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="70e018e3f27ead8d955acd70e0e11737"></a><!-- doxytag: member="log4cxx::spi::ErrorHandler::~ErrorHandler" ref="70e018e3f27ead8d955acd70e0e11737" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ~<a class="el" href="classlog4cxx_1_1spi_1_1_error_handler.html">ErrorHandler</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><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="b087032b921fcef1735256049d38f0c1"></a><!-- doxytag: member="log4cxx::spi::ErrorHandler::error" ref="b087032b921fcef1735256049d38f0c1" args="(const LogString &message, const std::exception &e, int errorCode, const LoggingEventPtr &event) const =0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void error </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="mdname" nowrap> <em>message</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const std::exception & </td>
<td class="mdname" nowrap> <em>e</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>errorCode</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggingEventPtr</a> & </td>
<td class="mdname" nowrap> <em>event</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This method is invoked to handle the error.
<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>message</em> </td><td>The message assoicated with the error. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>e</em> </td><td>The Exption that was thrown when the error occured. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>errorCode</em> </td><td>The error code associated with the error. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The logging event that the failing appender is asked to log. </td></tr>
</table>
</dl>
<p>
Implemented in <a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#24071234bd8fa94ccab51c6ac5e246c5">OnlyOnceErrorHandler</a>, and <a class="el" href="classlog4cxx_1_1varia_1_1_fallback_error_handler.html#24071234bd8fa94ccab51c6ac5e246c5">FallbackErrorHandler</a>. </td>
</tr>
</table>
<a class="anchor" name="390324c11808d0cd4fee6c3967932f27"></a><!-- doxytag: member="log4cxx::spi::ErrorHandler::error" ref="390324c11808d0cd4fee6c3967932f27" args="(const LogString &message) const =0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void error </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>message</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
This method is normally used to just print the error message passed as a parameter.
<p>
<p>
Implemented in <a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#d92a3ce84facc670863be59563d0603d">OnlyOnceErrorHandler</a>, and <a class="el" href="classlog4cxx_1_1varia_1_1_fallback_error_handler.html#40069b80e5ee8953b25177cc3574aa4b">FallbackErrorHandler</a>. </td>
</tr>
</table>
<a class="anchor" name="20b213d025014be558dfab7e11652825"></a><!-- doxytag: member="log4cxx::spi::ErrorHandler::error" ref="20b213d025014be558dfab7e11652825" args="(const LogString &message, const std::exception &e, int errorCode) const =0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void error </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="namespacelog4cxx.html#d7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="mdname" nowrap> <em>message</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const std::exception & </td>
<td class="mdname" nowrap> <em>e</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>errorCode</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"> const<code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Equivalent to the error(const String&, <a class="el" href="classlog4cxx_1_1helpers_1_1_exception.html">helpers::Exception</a>&, int, <a class="el" href="classlog4cxx_1_1spi_1_1_logging_event.html">spi::LoggingEvent</a>&) with the the event parameteter set to null.
<p>
<p>
Implemented in <a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#9084c6c8c225845ed09867b730590514">OnlyOnceErrorHandler</a>, and <a class="el" href="classlog4cxx_1_1varia_1_1_fallback_error_handler.html#9084c6c8c225845ed09867b730590514">FallbackErrorHandler</a>. </td>
</tr>
</table>
<a class="anchor" name="bf38035eedf752b85b9ffdcf414edd64"></a><!-- doxytag: member="log4cxx::spi::ErrorHandler::setAppender" ref="bf38035eedf752b85b9ffdcf414edd64" args="(const AppenderPtr &appender)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void setAppender </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>appender</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the appender for which errors are handled.
<p>
This method is usually called when the error handler is configured.
<p>
Implemented in <a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#5d46275bd2a01b2102f4b03b294ec50b">OnlyOnceErrorHandler</a>, and <a class="el" href="classlog4cxx_1_1varia_1_1_fallback_error_handler.html#5e3545411b1bb167ca7c30d554cb7252">FallbackErrorHandler</a>. </td>
</tr>
</table>
<a class="anchor" name="bc2bb91894f25f42d8e1a429c8bec2bc"></a><!-- doxytag: member="log4cxx::spi::ErrorHandler::setBackupAppender" ref="bc2bb91894f25f42d8e1a429c8bec2bc" args="(const AppenderPtr &appender)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void setBackupAppender </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>appender</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the appender to fallback upon in case of failure.
<p>
<p>
Implemented in <a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#f5ce3a0cde4a80c96cf5dee6389550b5">OnlyOnceErrorHandler</a>, and <a class="el" href="classlog4cxx_1_1varia_1_1_fallback_error_handler.html#953bb1714ea396c901a07bbdf6a9e923">FallbackErrorHandler</a>. </td>
</tr>
</table>
<a class="anchor" name="657c680e0246d95168aecbe4d299822b"></a><!-- doxytag: member="log4cxx::spi::ErrorHandler::setLogger" ref="657c680e0246d95168aecbe4d299822b" args="(const LoggerPtr &logger)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void setLogger </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LoggerPtr</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>logger</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Add a reference to a logger to which the failing appender might be attached to.
<p>
The failing appender will be searched and replaced only in the loggers you add through this method.<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>logger</em> </td><td>One of the loggers that will be searched for the failing appender in view of replacement. </td></tr>
</table>
</dl>
<p>
Implemented in <a class="el" href="classlog4cxx_1_1helpers_1_1_only_once_error_handler.html#d71cb681f580c2dd0ac0b15c4c5cf979">OnlyOnceErrorHandler</a>, and <a class="el" href="classlog4cxx_1_1varia_1_1_fallback_error_handler.html#d71cb681f580c2dd0ac0b15c4c5cf979">FallbackErrorHandler</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="errorhandler_8h.html">errorhandler.h</a></ul>
<!--
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>
|