Google Git
Sign in
apache / logging-log4cxx / 64d2ac977e51344f76729b3f566dd9d426a4631f / . / xdocs / www / manual / classlog4cxx_1_1helpers_1_1FileWatchdog.html
blob: d1851ee51fac4c4b7f6de3a04f45c41dac0667ef [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></div>
<h1>FileWatchdog Class Reference</h1>Inheritance diagram for FileWatchdog:<p><center><img src="classlog4cxx_1_1helpers_1_1FileWatchdog__inherit__graph.png" border="0" usemap="#FileWatchdog__inherit__map" alt="Inheritance graph"></center>
<map name="FileWatchdog__inherit__map">
<area href="classlog4cxx_1_1helpers_1_1Thread.html" shape="rect" coords="26,168,77,192" alt="">
<area href="classlog4cxx_1_1helpers_1_1ObjectImpl.html" shape="rect" coords="14,93,89,117" alt="">
<area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="26,19,77,43" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for FileWatchdog:<p><center><img src="classlog4cxx_1_1helpers_1_1FileWatchdog__coll__graph.png" border="0" usemap="#FileWatchdog__coll__map" alt="Collaboration graph"></center>
<map name="FileWatchdog__coll__map">
<area href="classlog4cxx_1_1helpers_1_1Thread.html" shape="rect" coords="84,186,134,210" alt="">
<area href="classlog4cxx_1_1helpers_1_1ObjectImpl.html" shape="rect" coords="6,96,81,120" alt="">
<area href="classlog4cxx_1_1helpers_1_1Object.html" shape="rect" coords="18,18,69,42" alt="">
<area href="classlog4cxx_1_1helpers_1_1ObjectPtrT.html" shape="rect" coords="105,96,177,120" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classlog4cxx_1_1helpers_1_1FileWatchdog-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>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1FileWatchdog.html#a0">setDelay</a> (long <a class="el" href="classlog4cxx_1_1helpers_1_1FileWatchdog.html#p1">delay</a>)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1FileWatchdog.html#a1">run</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1FileWatchdog.html#a2">start</a> ()</td></tr>
<tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1FileWatchdog.html#s0">DEFAULT_DELAY</a> = 60000</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>String&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1FileWatchdog.html#p0">filename</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>long&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classlog4cxx_1_1helpers_1_1FileWatchdog.html#p1">delay</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Check every now and then that a certain file has not changed. If it has, then call the #doOnChange method.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1" doxytag="log4cxx::helpers::FileWatchdog::run" ></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"> void run </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
If this thread was constructed using a separate <a class="el" href="classlog4cxx_1_1helpers_1_1Runnable.html">Runnable</a> run object, then that <a class="el" href="classlog4cxx_1_1helpers_1_1Runnable.html">Runnable</a> object's run method is called; otherwise, this method does nothing and returns.
<p>
Reimplemented from <a class="el" href="classlog4cxx_1_1helpers_1_1Thread.html#a4">Thread</a>. </td>
</tr>
</table>
<a class="anchor" name="a0" doxytag="log4cxx::helpers::FileWatchdog::setDelay" ></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"> void setDelay </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">long&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>delay</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the delay to observe between each check of the file changes. </td>
</tr>
</table>
<a class="anchor" name="a2" doxytag="log4cxx::helpers::FileWatchdog::start" ></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"> void start </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Causes this thread to begin execution; calls the run method of this thread.
<p>
Reimplemented from <a class="el" href="classlog4cxx_1_1helpers_1_1Thread.html#a3">Thread</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="s0" doxytag="log4cxx::helpers::FileWatchdog::DEFAULT_DELAY" ></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"> long <a class="el" href="classlog4cxx_1_1helpers_1_1FileWatchdog.html#s0">DEFAULT_DELAY</a> = 60000<code> [static]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The default delay between every file modification check, set to 60 seconds. </td>
</tr>
</table>
<a class="anchor" name="p1" doxytag="log4cxx::helpers::FileWatchdog::delay" ></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"> long <a class="el" href="classlog4cxx_1_1helpers_1_1FileWatchdog.html#p1">delay</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The delay to observe between every check. By default set DEFAULT_DELAY. </td>
</tr>
</table>
<a class="anchor" name="p0" doxytag="log4cxx::helpers::FileWatchdog::filename" ></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"> String <a class="el" href="classlog4cxx_1_1helpers_1_1FileWatchdog.html#p0">filename</a><code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The name of the file to observe for changes. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li>filewatchdog.h<li>filewatchdog.cpp</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 -->