<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CFileSystemWatcher.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> > <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<div class="left">
<form id="FSearchBox" action="search.php" method="get">
<img id="MSearchSelect" src="search/mag.png" alt=""/>
<input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"/>
</form>
</div><div class="right"></div>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">CFileSystemWatcher.h</div> </div>
</div>
<div class="contents">
<a href="_c_file_system_watcher_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* +---------------------------------------------------------------------------+</span>
<a name="l00002"></a>00002 <span class="comment"> | The Mobile Robot Programming Toolkit (MRPT) C++ library |</span>
<a name="l00003"></a>00003 <span class="comment"> | |</span>
<a name="l00004"></a>00004 <span class="comment"> | http://www.mrpt.org/ |</span>
<a name="l00005"></a>00005 <span class="comment"> | |</span>
<a name="l00006"></a>00006 <span class="comment"> | Copyright (C) 2005-2011 University of Malaga |</span>
<a name="l00007"></a>00007 <span class="comment"> | |</span>
<a name="l00008"></a>00008 <span class="comment"> | This software was written by the Machine Perception and Intelligent |</span>
<a name="l00009"></a>00009 <span class="comment"> | Robotics Lab, University of Malaga (Spain). |</span>
<a name="l00010"></a>00010 <span class="comment"> | Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es> |</span>
<a name="l00011"></a>00011 <span class="comment"> | |</span>
<a name="l00012"></a>00012 <span class="comment"> | This file is part of the MRPT project. |</span>
<a name="l00013"></a>00013 <span class="comment"> | |</span>
<a name="l00014"></a>00014 <span class="comment"> | MRPT is free software: you can redistribute it and/or modify |</span>
<a name="l00015"></a>00015 <span class="comment"> | it under the terms of the GNU General Public License as published by |</span>
<a name="l00016"></a>00016 <span class="comment"> | the Free Software Foundation, either version 3 of the License, or |</span>
<a name="l00017"></a>00017 <span class="comment"> | (at your option) any later version. |</span>
<a name="l00018"></a>00018 <span class="comment"> | |</span>
<a name="l00019"></a>00019 <span class="comment"> | MRPT is distributed in the hope that it will be useful, |</span>
<a name="l00020"></a>00020 <span class="comment"> | but WITHOUT ANY WARRANTY; without even the implied warranty of |</span>
<a name="l00021"></a>00021 <span class="comment"> | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |</span>
<a name="l00022"></a>00022 <span class="comment"> | GNU General Public License for more details. |</span>
<a name="l00023"></a>00023 <span class="comment"> | |</span>
<a name="l00024"></a>00024 <span class="comment"> | You should have received a copy of the GNU General Public License |</span>
<a name="l00025"></a>00025 <span class="comment"> | along with MRPT. If not, see <http://www.gnu.org/licenses/>. |</span>
<a name="l00026"></a>00026 <span class="comment"> | |</span>
<a name="l00027"></a>00027 <span class="comment"> +---------------------------------------------------------------------------+ */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef CFileSystemWatcher_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define CFileSystemWatcher_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <<a class="code" href="utils__defs_8h.html">mrpt/utils/utils_defs.h</a>></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <<a class="code" href="os_8h.html">mrpt/system/os.h</a>></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <<a class="code" href="threads_8h.html">mrpt/system/threads.h</a>></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <<a class="code" href="_c_thread_safe_queue_8h.html">mrpt/utils/CThreadSafeQueue.h</a>></span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="comment">/*---------------------------------------------------------------</span>
<a name="l00037"></a>00037 <span class="comment"> Class</span>
<a name="l00038"></a>00038 <span class="comment"> ---------------------------------------------------------------*/</span>
<a name="l00039"></a>00039 <span class="keyword">namespace </span>mrpt
<a name="l00040"></a>00040 {
<a name="l00041"></a>00041 <span class="keyword">namespace </span>system
<a name="l00042"></a>00042 {<span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment"> /** This class subscribes to notifications of file system changes, thus it can be used to efficiently stay informed about changes in a directory tree.</span>
<a name="l00044"></a>00044 <span class="comment"> * - Windows: Requires Windows 2000 or newer.</span>
<a name="l00045"></a>00045 <span class="comment"> * - Linux: Requires kernel 2.6.13 or newer.</span>
<a name="l00046"></a>00046 <span class="comment"> * Using this class in an old Linux or other unsoported system (Unix,etc...) has no effect, i.e. no notification will be ever received.</span>
<a name="l00047"></a>00047 <span class="comment"> * \sa CDirectoryExplorer</span>
<a name="l00048"></a>00048 <span class="comment"> * \ingroup mrpt_base_grp</span>
<a name="l00049"></a>00049 <span class="comment"> */</span>
<a name="l00050"></a>00050 <span class="keyword">class </span><a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> CFileSystemWatcher
<a name="l00051"></a>00051 {
<a name="l00052"></a>00052 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment"> /** Each of the changes detected by utils::CFileSystemWatcher</span>
<a name="l00054"></a>00054 <span class="comment"> */</span>
<a name="l00055"></a>00055 <span class="keyword">struct </span><a class="code" href="base_2include_2mrpt_2base_2link__pragmas_8h.html#a6045fa0129b1a3d6c8bf895470e66574">BASE_IMPEXP</a> TFileSystemChange
<a name="l00056"></a>00056 {
<a name="l00057"></a><a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a5e9d3a6ca1a14457828c293b21b91f06">00057</a> <a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html" title="Each of the changes detected by utils::CFileSystemWatcher.">TFileSystemChange</a>() :
<a name="l00058"></a>00058 path(), isDir(false),
<a name="l00059"></a>00059 eventModified(false), eventCloseWrite(false),
<a name="l00060"></a>00060 eventDeleted(false), eventMovedTo(false),
<a name="l00061"></a>00061 eventMovedFrom(false), eventCreated(false),
<a name="l00062"></a>00062 eventAccessed(false) {}
<a name="l00063"></a>00063
<a name="l00064"></a><a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#aee48043e5cb15a4f6566a26d50abf9a0">00064</a> std::string <a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#aee48043e5cb15a4f6566a26d50abf9a0" title="Complete path of the file/directory that has changed.">path</a>; <span class="comment">//!< Complete path of the file/directory that has changed.</span>
<a name="l00065"></a><a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a3fea48bde787d0e1ea9f2c87bf1af84d">00065</a> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a3fea48bde787d0e1ea9f2c87bf1af84d" title="Whether the event happened to a file or a directory.">isDir</a>; <span class="comment">//!< Whether the event happened to a file or a directory.</span>
<a name="l00066"></a><a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a0d7699b595475e97979dfda3a53f5eb5">00066</a> <span class="comment"></span> <span class="keywordtype">bool</span> <a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a0d7699b595475e97979dfda3a53f5eb5">eventModified</a>;
<a name="l00067"></a><a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a091184cd5e4e1a776732627d8822c1f2">00067</a> <span class="keywordtype">bool</span> <a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a091184cd5e4e1a776732627d8822c1f2">eventCloseWrite</a>;
<a name="l00068"></a><a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a66775668d06a8e8067e511562d1112dc">00068</a> <span class="keywordtype">bool</span> <a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a66775668d06a8e8067e511562d1112dc">eventDeleted</a>;
<a name="l00069"></a><a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a8536077f539ccf7d77038cd7893b36c5">00069</a> <span class="keywordtype">bool</span> <a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a8536077f539ccf7d77038cd7893b36c5">eventMovedTo</a>;
<a name="l00070"></a><a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#ab308bfd6a9773b76874fd4ceb9dd25f8">00070</a> <span class="keywordtype">bool</span> <a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#ab308bfd6a9773b76874fd4ceb9dd25f8">eventMovedFrom</a>;
<a name="l00071"></a><a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a1fb2aa1e021e5952c397c66c96feb181">00071</a> <span class="keywordtype">bool</span> <a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a1fb2aa1e021e5952c397c66c96feb181">eventCreated</a>;
<a name="l00072"></a><a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a79d0f9c629f58d0746278814a1295274">00072</a> <span class="keywordtype">bool</span> <a class="code" href="structmrpt_1_1system_1_1_c_file_system_watcher_1_1_t_file_system_change.html#a79d0f9c629f58d0746278814a1295274">eventAccessed</a>;
<a name="l00073"></a>00073 };
<a name="l00074"></a>00074
<a name="l00075"></a><a class="code" href="classmrpt_1_1system_1_1_c_file_system_watcher.html#ac173fee6e9ae444aa792fb3b7be2ffc1">00075</a> <span class="keyword">typedef</span> std::deque<TFileSystemChange> <a class="code" href="classmrpt_1_1system_1_1_c_file_system_watcher.html#ac173fee6e9ae444aa792fb3b7be2ffc1">TFileSystemChangeList</a>;
<a name="l00076"></a>00076 <span class="comment"></span>
<a name="l00077"></a>00077 <span class="comment"> /** Creates the subscription to a specified path.</span>
<a name="l00078"></a>00078 <span class="comment"> * \param path The file or directory to watch.</span>
<a name="l00079"></a>00079 <span class="comment"> */</span>
<a name="l00080"></a>00080 <a class="code" href="classmrpt_1_1system_1_1_c_file_system_watcher.html" title="This class subscribes to notifications of file system changes, thus it can be used to efficiently sta...">CFileSystemWatcher</a>( <span class="keyword">const</span> <a class="code" href="classstd_1_1string.html" title="STL class.">std::string</a> &path );
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment"> /** Destructor</span>
<a name="l00083"></a>00083 <span class="comment"> */</span>
<a name="l00084"></a>00084 <span class="keyword">virtual</span> ~<a class="code" href="classmrpt_1_1system_1_1_c_file_system_watcher.html" title="This class subscribes to notifications of file system changes, thus it can be used to efficiently sta...">CFileSystemWatcher</a>();
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment"> /** Call this method sometimes to get the list of changes in the watched directory.</span>
<a name="l00087"></a>00087 <span class="comment"> * \sa processChange</span>
<a name="l00088"></a>00088 <span class="comment"> */</span>
<a name="l00089"></a>00089 <span class="keywordtype">void</span> getChanges( <a class="code" href="classstd_1_1deque.html" title="STL class.">TFileSystemChangeList</a> &out_list );
<a name="l00090"></a>00090
<a name="l00091"></a>00091 <span class="keyword">private</span>:
<a name="l00092"></a><a class="code" href="classmrpt_1_1system_1_1_c_file_system_watcher.html#ab8d6793467721e8b7e7b8ec7963ed156">00092</a> std::string <a class="code" href="classmrpt_1_1system_1_1_c_file_system_watcher.html#ab8d6793467721e8b7e7b8ec7963ed156" title="Ended in "/".">m_watchedDirectory</a>; <span class="comment">//!< Ended in "/"</span>
<a name="l00093"></a>00093 <span class="comment"></span><span class="preprocessor"> #ifdef MRPT_OS_WINDOWS</span>
<a name="l00094"></a>00094 <span class="preprocessor"></span> <span class="keywordtype">void</span> *m_hNotif;
<a name="l00095"></a>00095 mrpt<a class="code" href="structmrpt_1_1system_1_1_t_thread_handle.html" title="This structure contains the information needed to interface the threads API on each platform:...">::system::TThreadHandle</a> m_watchThread;
<a name="l00096"></a>00096 <span class="keywordtype">void</span> thread_win32_watch(); <span class="comment">//!< Watch thread; only needed in win32</span>
<a name="l00097"></a>00097 <span class="comment"></span> mrpt<a class="code" href="classmrpt_1_1utils_1_1_c_thread_safe_queue.html" title="A thread-safe template queue for object passing between threads; for a template argument of T...">::utils::CThreadSafeQueue<TFileSystemChange></a> m_queue_events_win32;
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="preprocessor"> #endif</span>
<a name="l00100"></a>00100 <span class="preprocessor"></span>
<a name="l00101"></a>00101 <span class="preprocessor"> #if defined(MRPT_OS_LINUX) || defined(MRPT_OS_APPLE)</span>
<a name="l00102"></a>00102 <span class="preprocessor"></span> <span class="keywordtype">int</span> m_fd; <span class="comment">//!< The fd returned by inotify_init.</span>
<a name="l00103"></a>00103 <span class="comment"></span> <span class="keywordtype">int</span> m_wd; <span class="comment">//!< The fd of the watch.</span>
<a name="l00104"></a>00104 <span class="comment"></span><span class="preprocessor"> #endif</span>
<a name="l00105"></a>00105 <span class="preprocessor"></span>
<a name="l00106"></a>00106 }; <span class="comment">// End of class def.</span>
<a name="l00107"></a>00107
<a name="l00108"></a>00108 } <span class="comment">// End of namespace</span>
<a name="l00109"></a>00109 } <span class="comment">// End of namespace</span>
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150"> </td></tr> </table> </body></html>
