Google Git
Sign in
apache / logging-log4cxx / bc918db26e1badbee741907044632b7801f3a3ce / . / xdocs / www / manual / classlog4cxx_1_1spi_1_1TriggeringEventEvaluator.html
blob: 1782fedd9d7d21da93289bd8cd852db6f810df3e [file] [log] [blame]
<html>
<head>
<title>
log4cxx - Documentation
</title>
<link href="../css/doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body bgcolor="#ffffff" text="#000000" link="#525D76">
<!-- START Header table -->
<table border="0" cellspacing="0" width="90%">
<!-- TOP IMAGE -->
<tr>
<td colspan="2">
<a href="http://logging.apache.org">
<img src="http://logging.apache.org/images/ls-logo.jpg" align="left" border="0"/>
</a>
</td>
</tr>
</table>
<!-- END Header table -->
<!-- START main table -->
<table id="main" border="0" width="90%" cellspacing="2" cellpadding="0">
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr>
<!-- LEFT SIDE NAVIGATION -->
<td id="navbar" valign="top">
<!-- ============================================================ -->
<table id="navbar" border="0" cellspacing="0" cellpadding="0">
<tr >
<td class="navbarHeader" nowrap="true">
<strong>Apache</strong>
</td>
</tr>
<tr><td class="navbarItem"><small> <a href="http://www.apache.org">Apache Home</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="http://logging.apache.org/">Logging Services</a>
</small></td></tr>
<tr >
<td class="navbarHeader" nowrap="true">
<strong>log4cxx project</strong>
</td>
</tr>
<tr><td class="navbarItem"><small> <a href="../index.html">About</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../news.html">News</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../team.html">Team</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../manual/index.html">Documentation</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../performance.html">Performance</a>
</small></td></tr>
<tr><td class="navbarItem"><small> <a href="../download.html">Download</a>
</small></td></tr>
</table>
</td>
<td id="mainContents" align="left" valign="top">
<hr>
<!-- Generated by Doxygen 1.3.5 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
<h1>TriggeringEventEvaluator Class Reference</h1>Inheritance diagram for TriggeringEventEvaluator:<p><center><img src="classlog4cxx_1_1spi_1_1TriggeringEventEvaluator__inherit__graph.png" border="0" usemap="#TriggeringEventEvaluator__inherit__map" alt="Inheritance graph"></center>
<map name="TriggeringEventEvaluator__inherit__map">
<area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="60,18,110,42" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for TriggeringEventEvaluator:<p><center><img src="classlog4cxx_1_1spi_1_1TriggeringEventEvaluator__coll__graph.png" border="0" usemap="#TriggeringEventEvaluator__coll__map" alt="Collaboration graph"></center>
<map name="TriggeringEventEvaluator__coll__map">
<area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="60,18,110,42" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classlog4cxx_1_1spi_1_1TriggeringEventEvaluator-members.html">List of all members.</a><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 bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1spi_1_1TriggeringEventEvaluator.html#a0">isTriggeringEvent</a> (const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">spi::LoggingEventPtr</a> &amp;event)=0</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Implementions of this interface allow certain appenders to decide when to perform an appender specific action.<p>
For example the <a class="el" href="classlog4cxx_1_1net_1_1SMTPAppender.html">SMTPAppender</a> sends an email when the <a class="el" href="classlog4cxx_1_1spi_1_1TriggeringEventEvaluator.html#a0">isTriggeringEvent</a> method returns <code>true</code> and adds the event to an internal buffer when the returned result is <code>false</code>.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a0" doxytag="log4cxx::spi::TriggeringEventEvaluator::isTriggeringEvent" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual bool isTriggeringEvent </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">const <a class="el" href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html">spi::LoggingEventPtr</a> &amp;&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>event</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Is this the triggering event? </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li>triggeringeventevaluator.h</ul>
</td>
</tr>
<!-- FOOTER -->
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr><td colspan="2">
<div align="center"><font color="#525D76" size="-1"><em>
Copyright &#169; 1999-2004, Apache Software Foundation
</em></font></div>
</td></tr>
</table>
<!-- END main table -->
</body>
</html>
<!-- end the processing -->