<!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: FileWatchdog 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_file_watchdog.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>FileWatchdog Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="log4cxx::helpers::FileWatchdog" -->
<p>Check every now and then that a certain file has not changed.
<a href="#_details">More...</a></p>
<p><a href="classlog4cxx_1_1helpers_1_1_file_watchdog-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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#a51a44ce5ec6073f875da7a1896946b46">~FileWatchdog</a> ()</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_file_watchdog.html#aefe6623814493be741100e5a025b069e">setDelay</a> (long delay1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the delay to observe between each check of the file changes. <a href="#aefe6623814493be741100e5a025b069e"></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_file_watchdog.html#a60de64d75454385b23995437f1d72669">start</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static long </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#a339ae144d23b36d09a21da4767206ea3">DEFAULT_DELAY</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The default delay between every file modification check, set to 60 seconds. <a href="#a339ae144d23b36d09a21da4767206ea3"></a><br/></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_1helpers_1_1_file_watchdog.html#a44a68d4e8c945a01dda40a8e3014ac27">FileWatchdog</a> (const <a class="el" href="classlog4cxx_1_1_file.html">File</a> &filename)</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_file_watchdog.html#a8954ea8a0bff2e80da8c1dbec6a621d2">doOnChange</a> ()=0</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_file_watchdog.html#a028e7d72c2a034609e3c097701430e4f">checkAndConfigure</a> ()</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"><a class="el" href="classlog4cxx_1_1_file.html">File</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#a5eea5bedc36e0a29487dac7dd5725035">file</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the file to observe for changes. <a href="#a5eea5bedc36e0a29487dac7dd5725035"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#a3465e71050ee8220d3f57ba66c03e435">delay</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The delay to observe between every check. <a href="#a3465e71050ee8220d3f57ba66c03e435"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="log4cxx_8h.html#adcf85375d350e7045ac5570a2c922aec">log4cxx_time_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#a12e31c584480d7af070a5a8c3e4a9b67">lastModif</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#aa2194125bc0c6250f421b3ee503b2d0d">warnedAlready</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">volatile unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#afad9245c0b4d29181807680897ec7500">interrupted</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Check every now and then that a certain file has not changed. </p>
<p>If it has, then call the <a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#a8954ea8a0bff2e80da8c1dbec6a621d2">doOnChange</a> method. </p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a51a44ce5ec6073f875da7a1896946b46"></a><!-- doxytag: member="log4cxx::helpers::FileWatchdog::~FileWatchdog" ref="a51a44ce5ec6073f875da7a1896946b46" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html">FileWatchdog</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a44a68d4e8c945a01dda40a8e3014ac27"></a><!-- doxytag: member="log4cxx::helpers::FileWatchdog::FileWatchdog" ref="a44a68d4e8c945a01dda40a8e3014ac27" args="(const File &filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html">FileWatchdog</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlog4cxx_1_1_file.html">File</a> & </td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a028e7d72c2a034609e3c097701430e4f"></a><!-- doxytag: member="log4cxx::helpers::FileWatchdog::checkAndConfigure" ref="a028e7d72c2a034609e3c097701430e4f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void checkAndConfigure </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8954ea8a0bff2e80da8c1dbec6a621d2"></a><!-- doxytag: member="log4cxx::helpers::FileWatchdog::doOnChange" ref="a8954ea8a0bff2e80da8c1dbec6a621d2" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void doOnChange </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aefe6623814493be741100e5a025b069e"></a><!-- doxytag: member="log4cxx::helpers::FileWatchdog::setDelay" ref="aefe6623814493be741100e5a025b069e" args="(long delay1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setDelay </td>
<td>(</td>
<td class="paramtype">long </td>
<td class="paramname"><em>delay1</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the delay to observe between each check of the file changes. </p>
</div>
</div>
<a class="anchor" id="a60de64d75454385b23995437f1d72669"></a><!-- doxytag: member="log4cxx::helpers::FileWatchdog::start" ref="a60de64d75454385b23995437f1d72669" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a339ae144d23b36d09a21da4767206ea3"></a><!-- doxytag: member="log4cxx::helpers::FileWatchdog::DEFAULT_DELAY" ref="a339ae144d23b36d09a21da4767206ea3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#a339ae144d23b36d09a21da4767206ea3">DEFAULT_DELAY</a><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The default delay between every file modification check, set to 60 seconds. </p>
</div>
</div>
<a class="anchor" id="a3465e71050ee8220d3f57ba66c03e435"></a><!-- doxytag: member="log4cxx::helpers::FileWatchdog::delay" ref="a3465e71050ee8220d3f57ba66c03e435" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#a3465e71050ee8220d3f57ba66c03e435">delay</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The delay to observe between every check. </p>
<p>By default set DEFAULT_DELAY. </p>
</div>
</div>
<a class="anchor" id="a5eea5bedc36e0a29487dac7dd5725035"></a><!-- doxytag: member="log4cxx::helpers::FileWatchdog::file" ref="a5eea5bedc36e0a29487dac7dd5725035" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classlog4cxx_1_1_file.html">File</a> <a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#a5eea5bedc36e0a29487dac7dd5725035">file</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name of the file to observe for changes. </p>
</div>
</div>
<a class="anchor" id="afad9245c0b4d29181807680897ec7500"></a><!-- doxytag: member="log4cxx::helpers::FileWatchdog::interrupted" ref="afad9245c0b4d29181807680897ec7500" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">volatile unsigned int <a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#afad9245c0b4d29181807680897ec7500">interrupted</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a12e31c584480d7af070a5a8c3e4a9b67"></a><!-- doxytag: member="log4cxx::helpers::FileWatchdog::lastModif" ref="a12e31c584480d7af070a5a8c3e4a9b67" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="log4cxx_8h.html#adcf85375d350e7045ac5570a2c922aec">log4cxx_time_t</a> <a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#a12e31c584480d7af070a5a8c3e4a9b67">lastModif</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="aa2194125bc0c6250f421b3ee503b2d0d"></a><!-- doxytag: member="log4cxx::helpers::FileWatchdog::warnedAlready" ref="aa2194125bc0c6250f421b3ee503b2d0d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classlog4cxx_1_1helpers_1_1_file_watchdog.html#aa2194125bc0c6250f421b3ee503b2d0d">warnedAlready</a><code> [protected]</code></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="filewatchdog_8h.html">filewatchdog.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_file_watchdog.html">FileWatchdog</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>
