<!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: Action 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_action.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>Action Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::rolling::Action" --><!-- doxytag: inherits="log4cxx::helpers::ObjectImpl" -->
<p>A file system action performed as part of a rollover event.
<a href="#_details">More...</a></p>
<p>Inherits <a class="el" href="classlog4cxx_1_1helpers_1_1_object_impl.html">log4cxx::helpers::ObjectImpl</a>.</p>
<p>Inherited by <a class="el" href="classlog4cxx_1_1rolling_1_1_file_rename_action.html">FileRenameAction</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_g_z_compress_action.html">GZCompressAction</a>, and <a class="el" href="classlog4cxx_1_1rolling_1_1_zip_compress_action.html">ZipCompressAction</a>.</p>
<p><a href="classlog4cxx_1_1rolling_1_1_action-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">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_action.html#ad501335e019f714d88015e8c32f987cd">execute</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &pool) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform action. <a href="#ad501335e019f714d88015e8c32f987cd"></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_action.html#a84ba9693567c6e803f35336846cdfa5b">run</a> (<a class="el" href="classlog4cxx_1_1helpers_1_1_pool.html">log4cxx::helpers::Pool</a> &pool)</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_action.html#a5ae591df94fc66ccb85cbb6565368bca">close</a> ()</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_action.html#a8f31086c831baedbaa74038c8434fb7f">isComplete</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Tests if the action is complete. <a href="#a8f31086c831baedbaa74038c8434fb7f"></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_action.html#a2fe2c40c2361ea7ce145d83a68d4d523">reportException</a> (const std::exception &)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected 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_action.html#a9e72d404d52a0c6d6edefac30f76e02d">Action</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a9e72d404d52a0c6d6edefac30f76e02d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1rolling_1_1_action.html#abc234884dd56b88b74a7702c803a16be">~Action</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A file system action performed as part of a rollover event. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a9e72d404d52a0c6d6edefac30f76e02d"></a><!-- doxytag: member="log4cxx::rolling::Action::Action" ref="a9e72d404d52a0c6d6edefac30f76e02d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1rolling_1_1_action.html">Action</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="abc234884dd56b88b74a7702c803a16be"></a><!-- doxytag: member="log4cxx::rolling::Action::~Action" ref="abc234884dd56b88b74a7702c803a16be" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classlog4cxx_1_1rolling_1_1_action.html">Action</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5ae591df94fc66ccb85cbb6565368bca"></a><!-- doxytag: member="log4cxx::rolling::Action::close" ref="a5ae591df94fc66ccb85cbb6565368bca" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ad501335e019f714d88015e8c32f987cd"></a><!-- doxytag: member="log4cxx::rolling::Action::execute" ref="ad501335e019f714d88015e8c32f987cd" args="(log4cxx::helpers::Pool &pool) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool execute </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><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Perform action. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if successful. </dd></dl>
<p>Implemented in <a class="el" href="classlog4cxx_1_1rolling_1_1_file_rename_action.html#a868f2b05ba28a95cc71c9f3879c72f1d">FileRenameAction</a>, <a class="el" href="classlog4cxx_1_1rolling_1_1_g_z_compress_action.html#a868f2b05ba28a95cc71c9f3879c72f1d">GZCompressAction</a>, and <a class="el" href="classlog4cxx_1_1rolling_1_1_zip_compress_action.html#a868f2b05ba28a95cc71c9f3879c72f1d">ZipCompressAction</a>.</p>
</div>
</div>
<a class="anchor" id="a8f31086c831baedbaa74038c8434fb7f"></a><!-- doxytag: member="log4cxx::rolling::Action::isComplete" ref="a8f31086c831baedbaa74038c8434fb7f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isComplete </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Tests if the action is complete. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if action is complete. </dd></dl>
</div>
</div>
<a class="anchor" id="a2fe2c40c2361ea7ce145d83a68d4d523"></a><!-- doxytag: member="log4cxx::rolling::Action::reportException" ref="a2fe2c40c2361ea7ce145d83a68d4d523" args="(const std::exception &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void reportException </td>
<td>(</td>
<td class="paramtype">const std::exception & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a84ba9693567c6e803f35336846cdfa5b"></a><!-- doxytag: member="log4cxx::rolling::Action::run" ref="a84ba9693567c6e803f35336846cdfa5b" args="(log4cxx::helpers::Pool &pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void run </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><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="action_8h.html">action.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_action.html">Action</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>
