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

#include <mrpt/system/CFileSystemWatcher.h>

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

Public Types
using	TFileSystemChangeList = std::deque< TFileSystemChange >

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 Member Functions
void	thread_win32_watch ()
	Watch thread; only needed in win32. More...

Private Attributes
std::string	m_watchedDirectory
	Ended in "/". More...
void *	m_hNotif {nullptr}
std::thread	m_watchThread
std::queue< TFileSystemChange * >	m_queue_events_win32_msgs
std::mutex	m_queue_events_win32_cs

Member Typedef Documentation

TFileSystemChangeList

using mrpt::system::CFileSystemWatcher::TFileSystemChangeList = std::deque<TFileSystemChange>

Definition at line 48 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_, m_hNotif, m_watchedDirectory, m_watchThread, MRPT_END, MRPT_START, thread_win32_watch(), and THROW_EXCEPTION.

~CFileSystemWatcher()

CFileSystemWatcher::~CFileSystemWatcher ( )

virtual

Destructor.

Definition at line 90 of file CFileSystemWatcher.cpp.

References m_hNotif.

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 116 of file CFileSystemWatcher.cpp.

References ASSERTMSG_, mrpt::system::CFileSystemWatcher::TFileSystemChange::eventAccessed, mrpt::system::CFileSystemWatcher::TFileSystemChange::eventCloseWrite, mrpt::system::CFileSystemWatcher::TFileSystemChange::eventCreated, mrpt::system::CFileSystemWatcher::TFileSystemChange::eventDeleted, mrpt::system::CFileSystemWatcher::TFileSystemChange::eventModified, mrpt::system::CFileSystemWatcher::TFileSystemChange::eventMovedFrom, mrpt::system::CFileSystemWatcher::TFileSystemChange::eventMovedTo, mrpt::system::CFileSystemWatcher::TFileSystemChange::isDir, m_hNotif, m_queue_events_win32_cs, m_queue_events_win32_msgs, m_watchedDirectory, mrpt::system::os::memcpy(), and mrpt::system::CFileSystemWatcher::TFileSystemChange::path.

thread_win32_watch()

void CFileSystemWatcher::thread_win32_watch ( )

private

Watch thread; only needed in win32.

Definition at line 252 of file CFileSystemWatcher.cpp.

References ASSERTMSG_, mrpt::system::directoryExists(), mrpt::system::CFileSystemWatcher::TFileSystemChange::eventCreated, mrpt::system::CFileSystemWatcher::TFileSystemChange::eventDeleted, mrpt::system::CFileSystemWatcher::TFileSystemChange::eventModified, mrpt::system::CFileSystemWatcher::TFileSystemChange::eventMovedFrom, mrpt::system::CFileSystemWatcher::TFileSystemChange::eventMovedTo, mrpt::system::CFileSystemWatcher::TFileSystemChange::isDir, m_hNotif, m_queue_events_win32_cs, m_queue_events_win32_msgs, m_watchedDirectory, and mrpt::system::CFileSystemWatcher::TFileSystemChange::path.

Referenced by CFileSystemWatcher().

Member Data Documentation

m_hNotif

void* mrpt::system::CFileSystemWatcher::m_hNotif {nullptr}

private

Definition at line 69 of file CFileSystemWatcher.h.

Referenced by CFileSystemWatcher(), getChanges(), thread_win32_watch(), and ~CFileSystemWatcher().

m_queue_events_win32_cs

std::mutex mrpt::system::CFileSystemWatcher::m_queue_events_win32_cs

mutableprivate

Definition at line 74 of file CFileSystemWatcher.h.

Referenced by getChanges(), and thread_win32_watch().

m_queue_events_win32_msgs

std::queue<TFileSystemChange*> mrpt::system::CFileSystemWatcher::m_queue_events_win32_msgs

private

Definition at line 73 of file CFileSystemWatcher.h.

Referenced by getChanges(), and thread_win32_watch().

m_watchedDirectory

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

private

Ended in "/".

Definition at line 67 of file CFileSystemWatcher.h.

Referenced by CFileSystemWatcher(), getChanges(), and thread_win32_watch().

m_watchThread

std::thread mrpt::system::CFileSystemWatcher::m_watchThread

private

Definition at line 70 of file CFileSystemWatcher.h.

Referenced by CFileSystemWatcher().