blob: 2b2bb6c049ebcc2b76ab019dbb18600696906e4f [file] [log] [blame]
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Apache log4cxx: LogLog Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="http://logging.apache.org/log4cxx">Apache log4cxx</a>
&#160;<span id="projectnumber">Version 0.10.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classlog4cxx_1_1helpers_1_1_log_log.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classlog4cxx_1_1helpers_1_1_log_log-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">LogLog Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This class used to output log statements from within the <a class="el" href="namespacelog4cxx.html">log4cxx</a> package.
<a href="classlog4cxx_1_1helpers_1_1_log_log.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a88dfcd34424ce86013f633678aaa1357"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_log_log.html#a88dfcd34424ce86013f633678aaa1357">setInternalDebugging</a> (bool enabled)</td></tr>
<tr class="memdesc:a88dfcd34424ce86013f633678aaa1357"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allows to enable/disable <a class="el" href="namespacelog4cxx.html">log4cxx</a> internal logging. <a href="#a88dfcd34424ce86013f633678aaa1357">More...</a><br /></td></tr>
<tr class="separator:a88dfcd34424ce86013f633678aaa1357"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30676ec46ce71fa7d574d82df61774ec"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_log_log.html#a30676ec46ce71fa7d574d82df61774ec">debug</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;msg)</td></tr>
<tr class="memdesc:a30676ec46ce71fa7d574d82df61774ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is used to output <a class="el" href="namespacelog4cxx.html">log4cxx</a> internal debug statements. <a href="#a30676ec46ce71fa7d574d82df61774ec">More...</a><br /></td></tr>
<tr class="separator:a30676ec46ce71fa7d574d82df61774ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6080fcf7d80621b6c21ed0a6c3d9733f"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_log_log.html#a6080fcf7d80621b6c21ed0a6c3d9733f">debug</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;msg, const std::exception &amp;e)</td></tr>
<tr class="separator:a6080fcf7d80621b6c21ed0a6c3d9733f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afb81f0a62e9233a60efec4d3d57785f8"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_log_log.html#afb81f0a62e9233a60efec4d3d57785f8">error</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;msg)</td></tr>
<tr class="memdesc:afb81f0a62e9233a60efec4d3d57785f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is used to output <a class="el" href="namespacelog4cxx.html">log4cxx</a> internal error statements. <a href="#afb81f0a62e9233a60efec4d3d57785f8">More...</a><br /></td></tr>
<tr class="separator:afb81f0a62e9233a60efec4d3d57785f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad6cec8b22bde38237b7619251085360e"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_log_log.html#ad6cec8b22bde38237b7619251085360e">error</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;msg, const std::exception &amp;e)</td></tr>
<tr class="separator:ad6cec8b22bde38237b7619251085360e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a734c5d38691767fa43a442199d8a21a7"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_log_log.html#a734c5d38691767fa43a442199d8a21a7">setQuietMode</a> (bool quietMode)</td></tr>
<tr class="memdesc:a734c5d38691767fa43a442199d8a21a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">In quiet mode <a class="el" href="classlog4cxx_1_1helpers_1_1_log_log.html" title="This class used to output log statements from within the log4cxx package. ">LogLog</a> generates strictly no output, not even for errors. <a href="#a734c5d38691767fa43a442199d8a21a7">More...</a><br /></td></tr>
<tr class="separator:a734c5d38691767fa43a442199d8a21a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c24602dd46b8a0c3e4af3bb4b134833"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_log_log.html#a2c24602dd46b8a0c3e4af3bb4b134833">warn</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;msg)</td></tr>
<tr class="memdesc:a2c24602dd46b8a0c3e4af3bb4b134833"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is used to output <a class="el" href="namespacelog4cxx.html">log4cxx</a> internal warning statements. <a href="#a2c24602dd46b8a0c3e4af3bb4b134833">More...</a><br /></td></tr>
<tr class="separator:a2c24602dd46b8a0c3e4af3bb4b134833"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a759d18028a3587d45ababeb4b14984b4"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_log_log.html#a759d18028a3587d45ababeb4b14984b4">warn</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;msg, const std::exception &amp;e)</td></tr>
<tr class="separator:a759d18028a3587d45ababeb4b14984b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This class used to output log statements from within the <a class="el" href="namespacelog4cxx.html">log4cxx</a> package. </p>
<p>Log4cxx components cannot make <a class="el" href="namespacelog4cxx.html">log4cxx</a> logging calls. However, it is sometimes useful for the user to learn about what <a class="el" href="namespacelog4cxx.html">log4cxx</a> is doing. You can enable <a class="el" href="namespacelog4cxx.html">log4cxx</a> internal logging by calling the <b><a class="el" href="classlog4cxx_1_1helpers_1_1_log_log.html#a88dfcd34424ce86013f633678aaa1357" title="Allows to enable/disable log4cxx internal logging. ">setInternalDebugging</a></b> method.</p>
<p>All <a class="el" href="namespacelog4cxx.html">log4cxx</a> internal debug calls go to standard output where as internal error messages are sent to standard error output. All internal messages are prepended with the string "log4cxx: ". </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a30676ec46ce71fa7d574d82df61774ec"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void debug </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is used to output <a class="el" href="namespacelog4cxx.html">log4cxx</a> internal debug statements. </p>
<p>Output goes to the standard output. </p>
</div>
</div>
<a class="anchor" id="a6080fcf7d80621b6c21ed0a6c3d9733f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void debug </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::exception &amp;&#160;</td>
<td class="paramname"><em>e</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="afb81f0a62e9233a60efec4d3d57785f8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void error </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is used to output <a class="el" href="namespacelog4cxx.html">log4cxx</a> internal error statements. </p>
<p>There is no way to disable error statements. Output goes to stderr. </p>
</div>
</div>
<a class="anchor" id="ad6cec8b22bde38237b7619251085360e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void error </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::exception &amp;&#160;</td>
<td class="paramname"><em>e</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a88dfcd34424ce86013f633678aaa1357"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void setInternalDebugging </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>enabled</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allows to enable/disable <a class="el" href="namespacelog4cxx.html">log4cxx</a> internal logging. </p>
</div>
</div>
<a class="anchor" id="a734c5d38691767fa43a442199d8a21a7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void setQuietMode </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>quietMode</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>In quiet mode <a class="el" href="classlog4cxx_1_1helpers_1_1_log_log.html" title="This class used to output log statements from within the log4cxx package. ">LogLog</a> generates strictly no output, not even for errors. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">quietMode</td><td><code>true</code> for no output. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2c24602dd46b8a0c3e4af3bb4b134833"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void warn </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&#160;</td>
<td class="paramname"><em>msg</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is used to output <a class="el" href="namespacelog4cxx.html">log4cxx</a> internal warning statements. </p>
<p>There is no way to disable warning statements. Output goes to stderr. </p>
</div>
</div>
<a class="anchor" id="a759d18028a3587d45ababeb4b14984b4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void warn </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &amp;&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::exception &amp;&#160;</td>
<td class="paramname"><em>e</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="loglog_8h.html">loglog.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!--
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>