Detailed Description

This class subscribes to notifications of file system changes, thus it can be used to efficiently stay informed about changes in a directory tree.

Windows: Requires Windows 2000 or newer.
Linux: Requires kernel 2.6.13 or newer. Using this class in an old Linux or other unsoported system (Unix,etc...) has no effect, i.e. no notification will be ever received.
See also
CDirectoryExplorer

Definition at line 28 of file CFileSystemWatcher.h.

#include <mrpt/system/CFileSystemWatcher.h>

Classes
struct	TFileSystemChange
	Each of the changes detected by utils::CFileSystemWatcher. More...

Public Types
typedef std::deque< TFileSystemChange >	TFileSystemChangeList

Public Member Functions
	CFileSystemWatcher (const std::string &path)
	Creates the subscription to a specified path. More...

virtual	~CFileSystemWatcher ()
	Destructor. More...

void	getChanges (TFileSystemChangeList &out_list)
	Call this method sometimes to get the list of changes in the watched directory. More...

Private Attributes
std::string	m_watchedDirectory
	Ended in "/". More...

Member Typedef Documentation

◆ TFileSystemChangeList

typedef std::deque<TFileSystemChange> mrpt::system::CFileSystemWatcher::TFileSystemChangeList

Definition at line 53 of file CFileSystemWatcher.h.

Constructor & Destructor Documentation

◆ CFileSystemWatcher()

CFileSystemWatcher::CFileSystemWatcher ( const std::string & path )

Creates the subscription to a specified path.

Parameters

path	The file or directory to watch.

Definition at line 41 of file CFileSystemWatcher.cpp.

References ASSERT_, mrpt::system::createThreadFromObjectMethod(), m_watchedDirectory, MRPT_END, MRPT_START, and THROW_EXCEPTION.

◆ ~CFileSystemWatcher()

CFileSystemWatcher::~CFileSystemWatcher ( )

virtual

Destructor.

Definition at line 97 of file CFileSystemWatcher.cpp.

References mrpt::system::terminateThread().

Member Function Documentation

◆ getChanges()

void CFileSystemWatcher::getChanges ( TFileSystemChangeList & out_list )

Call this method sometimes to get the list of changes in the watched directory.

See also: processChange

Definition at line 126 of file CFileSystemWatcher.cpp.

Member Data Documentation

◆ m_watchedDirectory

std::string mrpt::system::CFileSystemWatcher::m_watchedDirectory

private

Ended in "/".

Definition at line 70 of file CFileSystemWatcher.h.

Referenced by CFileSystemWatcher(), and getChanges().