<!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: RolloverDescription 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_rollover_description.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>RolloverDescription Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::rolling::RolloverDescription" --><!-- doxytag: inherits="log4cxx::helpers::ObjectImpl" -->
<p>Inherits <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">log4cxx::helpers::ObjectImpl</a>.</p>
<p><a href="classlog4cxx_1_1rolling_1_1_rollover_description-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_rollover_description.html#a1b8696081bc181e318020daa27e24558">RolloverDescription</a> ()</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_rollover_description.html#aba76120b952d935182d089a474b5f77d">RolloverDescription</a> (const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> &activeFileName, const bool append, const ActionPtr &synchronous, const ActionPtr &asynchronous)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create new instance. <a href="#aba76120b952d935182d089a474b5f77d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rollover_description.html#a3d56afdd2e9b9e1445398c0ec05799f5">getActiveFileName</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Active log file name after rollover. <a href="#a3d56afdd2e9b9e1445398c0ec05799f5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rollover_description.html#af8cb171146140874fb651ca95e142805">getAppend</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ActionPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rollover_description.html#aba62aaae6162da1e476be9a2cdd6d799">getSynchronous</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classlog4cxx_1_1rolling_1_1_action.html" title="A file system action performed as part of a rollover event.">Action</a> to be completed after close of current active log file before returning control to caller. <a href="#aba62aaae6162da1e476be9a2cdd6d799"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ActionPtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_rollover_description.html#a8b428c75cd98c83ac42f04b21c2294ca">getAsynchronous</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classlog4cxx_1_1rolling_1_1_action.html" title="A file system action performed as part of a rollover event.">Action</a> to be completed after close of current active log file and before next rollover attempt, may be executed asynchronously. <a href="#a8b428c75cd98c83ac42f04b21c2294ca"></a><br/></td></tr>
</table>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a1b8696081bc181e318020daa27e24558"></a><!-- doxytag: member="log4cxx::rolling::RolloverDescription::RolloverDescription" ref="a1b8696081bc181e318020daa27e24558" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1rolling_1_1_rollover_description.html">RolloverDescription</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aba76120b952d935182d089a474b5f77d"></a><!-- doxytag: member="log4cxx::rolling::RolloverDescription::RolloverDescription" ref="aba76120b952d935182d089a474b5f77d" args="(const LogString &activeFileName, const bool append, const ActionPtr &synchronous, const ActionPtr &asynchronous)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1rolling_1_1_rollover_description.html">RolloverDescription</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> & </td>
<td class="paramname"><em>activeFileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool </td>
<td class="paramname"><em>append</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ActionPtr & </td>
<td class="paramname"><em>synchronous</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const ActionPtr & </td>
<td class="paramname"><em>asynchronous</em> </td>
</tr>
<tr>
<td></td>
<td>)</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">activeFileName</td><td>active log file name after rollover, may not be null. </td></tr>
<tr><td class="paramname">append</td><td>true if active log file after rollover should be opened for appending. </td></tr>
<tr><td class="paramname">synchronous</td><td>action to be completed after close of current active log file, may be null. </td></tr>
<tr><td class="paramname">asynchronous</td><td>action to be completed after close of current active log file and before next rollover attempt. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3d56afdd2e9b9e1445398c0ec05799f5"></a><!-- doxytag: member="log4cxx::rolling::RolloverDescription::getActiveFileName" ref="a3d56afdd2e9b9e1445398c0ec05799f5" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacelog4cxx.html#ad7ec98d27bca7666e23f27dd1fb181c8">LogString</a> getActiveFileName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Active log file name after rollover. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>active log file name after rollover. </dd></dl>
</div>
</div>
<a class="anchor" id="af8cb171146140874fb651ca95e142805"></a><!-- doxytag: member="log4cxx::rolling::RolloverDescription::getAppend" ref="af8cb171146140874fb651ca95e142805" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool getAppend </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8b428c75cd98c83ac42f04b21c2294ca"></a><!-- doxytag: member="log4cxx::rolling::RolloverDescription::getAsynchronous" ref="a8b428c75cd98c83ac42f04b21c2294ca" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ActionPtr getAsynchronous </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classlog4cxx_1_1rolling_1_1_action.html" title="A file system action performed as part of a rollover event.">Action</a> to be completed after close of current active log file and before next rollover attempt, may be executed asynchronously. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>action, may be null. </dd></dl>
</div>
</div>
<a class="anchor" id="aba62aaae6162da1e476be9a2cdd6d799"></a><!-- doxytag: member="log4cxx::rolling::RolloverDescription::getSynchronous" ref="aba62aaae6162da1e476be9a2cdd6d799" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ActionPtr getSynchronous </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="classlog4cxx_1_1rolling_1_1_action.html" title="A file system action performed as part of a rollover event.">Action</a> to be completed after close of current active log file before returning control to caller. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>action, may be null. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="rolloverdescription_8h.html">rolloverdescription.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_rollover_description.html">RolloverDescription</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>
