00001 /* +---------------------------------------------------------------------------+ 00002 | The Mobile Robot Programming Toolkit (MRPT) C++ library | 00003 | | 00004 | http://mrpt.sourceforge.net/ | 00005 | | 00006 | Copyright (C) 2005-2009 University of Malaga | 00007 | | 00008 | This software was written by the Machine Perception and Intelligent | 00009 | Robotics Lab, University of Malaga (Spain). | 00010 | Contact: Jose-Luis Blanco <jlblanco@ctima.uma.es> | 00011 | | 00012 | This file is part of the MRPT project. | 00013 | | 00014 | MRPT is free software: you can redistribute it and/or modify | 00015 | it under the terms of the GNU General Public License as published by | 00016 | the Free Software Foundation, either version 3 of the License, or | 00017 | (at your option) any later version. | 00018 | | 00019 | MRPT is distributed in the hope that it will be useful, | 00020 | but WITHOUT ANY WARRANTY; without even the implied warranty of | 00021 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | 00022 | GNU General Public License for more details. | 00023 | | 00024 | You should have received a copy of the GNU General Public License | 00025 | along with MRPT. If not, see <http://www.gnu.org/licenses/>. | 00026 | | 00027 +---------------------------------------------------------------------------+ */ 00028 #ifndef CFileSystemWatcher_H 00029 #define CFileSystemWatcher_H 00030 00031 #include <mrpt/utils/utils_defs.h> 00032 #include <mrpt/system/os.h> 00033 00034 /*--------------------------------------------------------------- 00035 Class 00036 ---------------------------------------------------------------*/ 00037 namespace mrpt 00038 { 00039 namespace system 00040 { 00041 /** This class subscribes to notifications of file system changes, thus it can be used to efficiently stay informed about changes in a directory tree. 00042 * - Windows: Requires Windows 2000 or newer. 00043 * - Linux: Requires kernel 2.6.13 or newer. 00044 * Using this class in an old Linux or other unsoported system (Unix,etc...) has no effect, i.e. no notification will be ever received. 00045 * \sa CDirectoryExplorer 00046 */ 00047 class MRPTDLLIMPEXP CFileSystemWatcher 00048 { 00049 public: 00050 /** Each of the changes detected by utils::CFileSystemWatcher 00051 */ 00052 struct MRPTDLLIMPEXP TFileSystemChange 00053 { 00054 std::string path; //!< Complete path of the file/directory that has changed. 00055 bool isDir; //!< Whether the event happened to a file or a directory. 00056 bool eventModified; 00057 bool eventCloseWrite; 00058 bool eventDeleted; 00059 bool eventMovedTo; 00060 bool eventMovedFrom; 00061 bool eventCreated; 00062 }; 00063 00064 typedef std::deque<TFileSystemChange> TFileSystemChangeList; 00065 00066 /** Creates the subscription to a specified path. 00067 * \param path The file or directory to watch. 00068 */ 00069 CFileSystemWatcher( const std::string &path ); 00070 00071 /** Destructor 00072 */ 00073 virtual ~CFileSystemWatcher(); 00074 00075 /** Call this method sometimes to get the list of changes in the watched directory. 00076 * \sa processChange 00077 */ 00078 void getChanges( TFileSystemChangeList &out_list ); 00079 00080 private: 00081 std::string m_watchedDirectory; //!< Ended in "/" 00082 #ifdef MRPT_OS_WINDOWS 00083 00084 #endif 00085 00086 #ifdef MRPT_OS_LINUX 00087 int m_fd; //!< The fd returned by inotify_init. 00088 int m_wd; //!< The fd of the watch. 00089 00090 #endif 00091 00092 }; // End of class def. 00093 00094 } // End of namespace 00095 } // End of namespace 00096 00097 #endif
Page generated by Doxygen 1.6.1 for MRPT 0.7.1 SVN: at Tue Dec 22 08:29:35 CET 2009 |