<!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: RootLogger 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_1spi_1_1_root_logger.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>RootLogger Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::spi::RootLogger" --><!-- doxytag: inherits="log4cxx::Logger" -->
<p><a class="el" href="classlog4cxx_1_1spi_1_1_root_logger.html" title="RootLogger sits at the top of the logger hierachy.">RootLogger</a> sits at the top of the logger hierachy.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1_logger.html">log4cxx::Logger</a>.</p>
<p><a href="classlog4cxx_1_1spi_1_1_root_logger-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_1spi_1_1_root_logger.html#aa92d5464b2cd3498f75d96d2a59f6b1a">RootLogger</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &pool, const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LevelPtr</a> &<a class="el" href="classlog4cxx_1_1_logger.html#a240ddc104a40a5f36edd8e63cee4d7e7">level</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The root logger names itself as "root". <a href="#aa92d5464b2cd3498f75d96d2a59f6b1a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LevelPtr</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1spi_1_1_root_logger.html#a2985ef12c0f256b14424004cbbb8854d">getEffectiveLevel</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the assigned level value without walking the logger hierarchy. <a href="#a2985ef12c0f256b14424004cbbb8854d"></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_1spi_1_1_root_logger.html#a16a971221dd24c189c9916ca2cf90b0a">setLevel</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LevelPtr</a> &<a class="el" href="classlog4cxx_1_1_logger.html#a240ddc104a40a5f36edd8e63cee4d7e7">level</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Setting a null value to the level of the root logger may have catastrophic results. <a href="#a16a971221dd24c189c9916ca2cf90b0a"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classlog4cxx_1_1spi_1_1_root_logger.html" title="RootLogger sits at the top of the logger hierachy.">RootLogger</a> sits at the top of the logger hierachy. </p>
<p>It is a regular logger except that it provides several guarantees.</p>
<p>First, it cannot be assigned a null level. Second, since root logger cannot have a parent, the <a class="el" href="classlog4cxx_1_1spi_1_1_root_logger.html#a2985ef12c0f256b14424004cbbb8854d" title="Return the assigned level value without walking the logger hierarchy.">getEffectiveLevel</a> method always returns the value of the level field without walking the hierarchy. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa92d5464b2cd3498f75d96d2a59f6b1a"></a><!-- doxytag: member="log4cxx::spi::RootLogger::RootLogger" ref="aa92d5464b2cd3498f75d96d2a59f6b1a" args="(log4cxx::helpers::Pool &pool, const LevelPtr &level)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1spi_1_1_root_logger.html">RootLogger</a> </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>pool</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">LevelPtr</a> & </td>
<td class="paramname"><em>level</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The root logger names itself as "root". </p>
<p>However, the root logger cannot be retrieved by name. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a2985ef12c0f256b14424004cbbb8854d"></a><!-- doxytag: member="log4cxx::spi::RootLogger::getEffectiveLevel" ref="a2985ef12c0f256b14424004cbbb8854d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LevelPtr</a>& getEffectiveLevel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the assigned level value without walking the logger hierarchy. </p>
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1_logger.html#a2985ef12c0f256b14424004cbbb8854d">Logger</a>.</p>
</div>
</div>
<a class="anchor" id="a16a971221dd24c189c9916ca2cf90b0a"></a><!-- doxytag: member="log4cxx::spi::RootLogger::setLevel" ref="a16a971221dd24c189c9916ca2cf90b0a" args="(const LevelPtr &level)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setLevel </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">LevelPtr</a> & </td>
<td class="paramname"><em>level</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Setting a null value to the level of the root logger may have catastrophic results. </p>
<p>We prevent this here. </p>
<p>Reimplemented from <a class="el" href="classlog4cxx_1_1_logger.html#a3f4bc4e85c61bb0caa027bd70842cc08">Logger</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="rootlogger_8h.html">rootlogger.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_1spi.html">spi</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1spi_1_1_root_logger.html">RootLogger</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>
