mrpt::system::CFileSystemWatcher Class Reference

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 31 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 56 of file CFileSystemWatcher.h.

Constructor & Destructor Documentation

CFileSystemWatcher()

mrpt::system::CFileSystemWatcher::CFileSystemWatcher

(

const std::string &

path

)

Creates the subscription to a specified path.

Parameters

path	The file or directory to watch.

~CFileSystemWatcher()

virtual mrpt::system::CFileSystemWatcher::~CFileSystemWatcher ( )

virtual

Destructor.

Member Function Documentation

getChanges()

void mrpt::system::CFileSystemWatcher::getChanges

(

TFileSystemChangeList &

out_list

)

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

See also

processChange

Member Data Documentation

m_watchedDirectory

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

private

Ended in "/".

Definition at line 73 of file CFileSystemWatcher.h.