<!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: ManualTriggeringPolicy 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_1rolling_1_1_manual_triggering_policy.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>ManualTriggeringPolicy Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::rolling::ManualTriggeringPolicy" --><!-- doxytag: inherits="log4cxx::rolling::TriggeringPolicy" -->
<p><a class="el" href="classlog4cxx_1_1rolling_1_1_manual_triggering_policy.html" title="ManualTriggeringPolicy only rolls over on explicit calls to RollingFileAppender.rollover().">ManualTriggeringPolicy</a> only rolls over on explicit calls to <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_file_appender_skeleton.html#a847aae8504e03bda7fb96fc04fd876fa" title="Implements the usual roll over behaviour.">RollingFileAppender.rollover()</a>.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1rolling_1_1_triggering_policy.html">log4cxx::rolling::TriggeringPolicy</a>.</p>
<p><a href="classlog4cxx_1_1rolling_1_1_manual_triggering_policy-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_1rolling_1_1_manual_triggering_policy.html#a98127eb72b279fd87b42ced604a61565">ManualTriggeringPolicy</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_manual_triggering_policy.html#ad1465d1456055bf68fc9c3a7416bb862">isTriggeringEvent</a> (<a class="el" href="classlog4cxx_1_1_appender.html">Appender</a> *appender, const <a class="el" href="classlog4cxx_1_1helpers_1_1_object_ptr_t.html">log4cxx::spi::LoggingEventPtr</a> &event, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &filename, size_t fileLength)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Determines if a rollover may be appropriate at this time. <a href="#ad1465d1456055bf68fc9c3a7416bb862"></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_1rolling_1_1_manual_triggering_policy.html#a580abdcb8fd42d07eaf679166f77bc34">activateOptions</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Activate the options that were previously set with calls to option setters. <a href="#a580abdcb8fd42d07eaf679166f77bc34"></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_1rolling_1_1_manual_triggering_policy.html#ac1d269357907e0809687a2bec962e1c8">setOption</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &option, const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set <code>option</code> to <code>value</code>. <a href="#ac1d269357907e0809687a2bec962e1c8"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classlog4cxx_1_1rolling_1_1_manual_triggering_policy.html" title="ManualTriggeringPolicy only rolls over on explicit calls to RollingFileAppender.rollover().">ManualTriggeringPolicy</a> only rolls over on explicit calls to <a class="el" href="classlog4cxx_1_1rolling_1_1_rolling_file_appender_skeleton.html#a847aae8504e03bda7fb96fc04fd876fa" title="Implements the usual roll over behaviour.">RollingFileAppender.rollover()</a>. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a98127eb72b279fd87b42ced604a61565"></a><!-- doxytag: member="log4cxx::rolling::ManualTriggeringPolicy::ManualTriggeringPolicy" ref="a98127eb72b279fd87b42ced604a61565" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1rolling_1_1_manual_triggering_policy.html">ManualTriggeringPolicy</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a580abdcb8fd42d07eaf679166f77bc34"></a><!-- doxytag: member="log4cxx::rolling::ManualTriggeringPolicy::activateOptions" ref="a580abdcb8fd42d07eaf679166f77bc34" args="(log4cxx::helpers::Pool &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void activateOptions </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><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Activate the options that were previously set with calls to option setters. </p>
<p>This allows to defer activiation of the options until all options have been set. This is required for components which have related options that remain ambigous until all are set.</p>
<p>For example, the <a class="el" href="classlog4cxx_1_1_file_appender.html" title="FileAppender appends log events to a file.">FileAppender</a> has the <a class="el" href="classlog4cxx_1_1_file_appender.html#a6a6c98222ccf2072dad5a434f9336930">File</a> and <a class="el" href="classlog4cxx_1_1_file_appender.html#a78ebca211ceb3a0b2960a48092089906">Append</a> options both of which are ambigous until the other is also set. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#af04d4bfbd66b46083b1aa042fdafbb06">OptionHandler</a>.</p>
</div>
</div>
<a class="anchor" id="ad1465d1456055bf68fc9c3a7416bb862"></a><!-- doxytag: member="log4cxx::rolling::ManualTriggeringPolicy::isTriggeringEvent" ref="ad1465d1456055bf68fc9c3a7416bb862" args="(Appender *appender, const log4cxx::spi::LoggingEventPtr &event, const LogString &filename, size_t fileLength)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool isTriggeringEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlog4cxx_1_1_appender.html">Appender</a> * </td>
<td class="paramname"><em>appender</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">log4cxx::spi::LoggingEventPtr</a> & </td>
<td class="paramname"><em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>fileLength</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Determines if a rollover may be appropriate at this time. </p>
<p>If true is returned, RolloverPolicy.rollover will be called but it can determine that a rollover is not warranted.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">appender</td><td>A reference to the appender. </td></tr>
<tr><td class="paramname">event</td><td>A reference to the currently event. </td></tr>
<tr><td class="paramname">filename</td><td>The filename for the currently active log file. </td></tr>
<tr><td class="paramname">fileLength</td><td>Length of the file in bytes. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if a rollover should occur. </dd></dl>
<p>Implements <a class="el" href="classlog4cxx_1_1rolling_1_1_triggering_policy.html#aa5300801d20e51d71952b221872458ec">TriggeringPolicy</a>.</p>
</div>
</div>
<a class="anchor" id="ac1d269357907e0809687a2bec962e1c8"></a><!-- doxytag: member="log4cxx::rolling::ManualTriggeringPolicy::setOption" ref="ac1d269357907e0809687a2bec962e1c8" args="(const LogString &option, const LogString &value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setOption </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>option</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set <code>option</code> to <code>value</code>. </p>
<p>The handling of each option depends on the OptionHandler instance. Some options may become active immediately whereas other may be activated only when <a class="el" href="classlog4cxx_1_1rolling_1_1_manual_triggering_policy.html#a580abdcb8fd42d07eaf679166f77bc34" title="Activate the options that were previously set with calls to option setters.">activateOptions</a> is called. </p>
<p>Implements <a class="el" href="classlog4cxx_1_1spi_1_1_option_handler.html#a8f2ae2ded63f80c627269c99b20c19ee">OptionHandler</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="manualtriggeringpolicy_8h.html">manualtriggeringpolicy.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_1rolling.html">rolling</a> </li>
<li class="navelem"><a class="el" href="classlog4cxx_1_1rolling_1_1_manual_triggering_policy.html">ManualTriggeringPolicy</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>
