<!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: AppenderAttachableImpl 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_appender_attachable_impl.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>AppenderAttachableImpl Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::helpers::AppenderAttachableImpl" --><!-- doxytag: inherits="log4cxx::spi::AppenderAttachable,log4cxx::helpers::ObjectImpl" -->
<p>Inherits <a class="el" href="classlog4cxx_1_1spi_1_1_appender_attachable.html">log4cxx::spi::AppenderAttachable</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_appender_attachable_impl-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_appender_attachable_impl.html#aa38221f96b9b8cbb7ca1853bdbaae238">AppenderAttachableImpl</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">Pool</a> &pool)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create new instance. <a href="#aa38221f96b9b8cbb7ca1853bdbaae238"></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_appender_attachable_impl.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_appender_attachable_impl.html#a55c31efee1904916b999395fa4d46a24">releaseRef</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_appender_attachable_impl.html#a7c0629acee8dbd1251474bea15d7c9e2">addAppender</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> &newAppender)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an appender. <a href="#a7c0629acee8dbd1251474bea15d7c9e2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_appender_attachable_impl.html#a08bfbe3bbd6a3f66ca2179115a605454">appendLoopOnAppenders</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">spi::LoggingEventPtr</a> &event, <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">Call the <code>doAppend</code> method on all attached appenders. <a href="#a08bfbe3bbd6a3f66ca2179115a605454"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual AppenderList </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_appender_attachable_impl.html#acc69e161ded85b39e02acff49a468019">getAllAppenders</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get all previously added appenders as an Enumeration. <a href="#acc69e161ded85b39e02acff49a468019"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_appender_attachable_impl.html#a1f3ed798a61436bcb4f8d00ba2c06eac">getAppender</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &name) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an appender by name. <a href="#a1f3ed798a61436bcb4f8d00ba2c06eac"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_appender_attachable_impl.html#a954246e920da70fa174dbb360c6e414c">isAttached</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> &appender) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if the specified appender is in the list of attached appenders, <code>false</code> otherwise. <a href="#a954246e920da70fa174dbb360c6e414c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_appender_attachable_impl.html#a54e02346d51609232e1b910a84e8e78d">removeAllAppenders</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove all previously added appenders. <a href="#a54e02346d51609232e1b910a84e8e78d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_appender_attachable_impl.html#aa138c98f247927433aff6adbc3223b07">removeAppender</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">Remove the appender passed as parameter from the list of appenders. <a href="#aa138c98f247927433aff6adbc3223b07"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_appender_attachable_impl.html#abffba3197830d70693fd9e91a8680bc6">removeAppender</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove the appender with the name passed as parameter from the list of appenders. <a href="#abffba3197830d70693fd9e91a8680bc6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1_mutex.html">log4cxx::helpers::Mutex</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_appender_attachable_impl.html#aeede7178b4d9f0a831d67367c19aa86e">getMutex</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">AppenderList </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_appender_attachable_impl.html#adc7e7ae40570070ae278892b86a805b2">appenderList</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Array of appenders. <a href="#adc7e7ae40570070ae278892b86a805b2"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa38221f96b9b8cbb7ca1853bdbaae238"></a><!-- doxytag: member="log4cxx::helpers::AppenderAttachableImpl::AppenderAttachableImpl" ref="aa38221f96b9b8cbb7ca1853bdbaae238" args="(Pool &pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_appender_attachable_impl.html">AppenderAttachableImpl</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">Pool</a> & </td>
<td class="paramname"><em>pool</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create new instance. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pool</td><td>pool, must be longer-lived than instance. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a7c0629acee8dbd1251474bea15d7c9e2"></a><!-- doxytag: member="log4cxx::helpers::AppenderAttachableImpl::addAppender" ref="a7c0629acee8dbd1251474bea15d7c9e2" args="(const AppenderPtr &newAppender)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void addAppender </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>newAppender</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Add an appender. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_appender_attachable.html#ab3e43f0096182894e0d5668039d6b32d">AppenderAttachable</a>.</p>
</div>
</div>
<a class="anchor" id="a0198815940c2715c84b0e04828cf8dfa"></a><!-- doxytag: member="log4cxx::helpers::AppenderAttachableImpl::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="a08bfbe3bbd6a3f66ca2179115a605454"></a><!-- doxytag: member="log4cxx::helpers::AppenderAttachableImpl::appendLoopOnAppenders" ref="a08bfbe3bbd6a3f66ca2179115a605454" args="(const spi::LoggingEventPtr &event, log4cxx::helpers::Pool &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int appendLoopOnAppenders </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 class="paramkey"></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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Call the <code>doAppend</code> method on all attached appenders. </p>
</div>
</div>
<a class="anchor" id="acc69e161ded85b39e02acff49a468019"></a><!-- doxytag: member="log4cxx::helpers::AppenderAttachableImpl::getAllAppenders" ref="acc69e161ded85b39e02acff49a468019" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual AppenderList getAllAppenders </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get all previously added appenders as an Enumeration. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_appender_attachable.html#a9a389340213c7fb29c7ddb12cd9a981a">AppenderAttachable</a>.</p>
</div>
</div>
<a class="anchor" id="a1f3ed798a61436bcb4f8d00ba2c06eac"></a><!-- doxytag: member="log4cxx::helpers::AppenderAttachableImpl::getAppender" ref="a1f3ed798a61436bcb4f8d00ba2c06eac" args="(const LogString &name) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">AppenderPtr</a> getAppender </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get an appender by name. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_appender_attachable.html#a694ea324c87a215b9c4aeaa553d98d37">AppenderAttachable</a>.</p>
</div>
</div>
<a class="anchor" id="aeede7178b4d9f0a831d67367c19aa86e"></a><!-- doxytag: member="log4cxx::helpers::AppenderAttachableImpl::getMutex" ref="aeede7178b4d9f0a831d67367c19aa86e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classlog4cxx_1_1helpers_1_1_mutex.html">log4cxx::helpers::Mutex</a>& getMutex </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a954246e920da70fa174dbb360c6e414c"></a><!-- doxytag: member="log4cxx::helpers::AppenderAttachableImpl::isAttached" ref="a954246e920da70fa174dbb360c6e414c" args="(const AppenderPtr &appender) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool isAttached </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> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns <code>true</code> if the specified appender is in the list of attached appenders, <code>false</code> otherwise. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_appender_attachable.html#adc9a0c0b18bea413320aac1eca5da8a0">AppenderAttachable</a>.</p>
</div>
</div>
<a class="anchor" id="a55c31efee1904916b999395fa4d46a24"></a><!-- doxytag: member="log4cxx::helpers::AppenderAttachableImpl::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="a54e02346d51609232e1b910a84e8e78d"></a><!-- doxytag: member="log4cxx::helpers::AppenderAttachableImpl::removeAllAppenders" ref="a54e02346d51609232e1b910a84e8e78d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void removeAllAppenders </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove all previously added appenders. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_appender_attachable.html#ab8123270851c4ea9d45bd4e010a4a655">AppenderAttachable</a>.</p>
</div>
</div>
<a class="anchor" id="aa138c98f247927433aff6adbc3223b07"></a><!-- doxytag: member="log4cxx::helpers::AppenderAttachableImpl::removeAppender" ref="aa138c98f247927433aff6adbc3223b07" args="(const AppenderPtr &appender)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void removeAppender </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>Remove the appender passed as parameter from the list of appenders. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_appender_attachable.html#ac428000920f71e6deaaf3e78855d5602">AppenderAttachable</a>.</p>
</div>
</div>
<a class="anchor" id="abffba3197830d70693fd9e91a8680bc6"></a><!-- doxytag: member="log4cxx::helpers::AppenderAttachableImpl::removeAppender" ref="abffba3197830d70693fd9e91a8680bc6" args="(const LogString &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void removeAppender </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remove the appender with the name passed as parameter from the list of appenders. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_appender_attachable.html#a3dd53e0c7f6baa7d73159ef0e82df529">AppenderAttachable</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="adc7e7ae40570070ae278892b86a805b2"></a><!-- doxytag: member="log4cxx::helpers::AppenderAttachableImpl::appenderList" ref="adc7e7ae40570070ae278892b86a805b2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AppenderList <a class="el" href="classlog4cxx_1_1helpers_1_1_appender_attachable_impl.html#adc7e7ae40570070ae278892b86a805b2">appenderList</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Array of appenders. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="appenderattachableimpl_8h.html">appenderattachableimpl.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_appender_attachable_impl.html">AppenderAttachableImpl</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>
