Torque3D Documentation / _generateds / Torque::FS::FileSystemChangeNotifier

Torque::FS::FileSystemChangeNotifier

Engine/source/core/volume.h

More...

Classes:

class
Torque::FS::FileSystemChangeNotifier::FileInfo

Public Types

Delegate< void(const Path &)>

ChangeDelegate 

Signal< void(const Path &)>

ChangeSignal

Protected Types

Map< Path, FileInfoList >

DirMap

map a directory to a list of files and their mod times

List< FileInfo >

FileInfoList

Protected Attributes

DirMap

mDirMap 

FileSystem *

mFS 

bool

mNotifying

Public Functions

FileSystemChangeNotifier(FileSystem * fs)

~FileSystemChangeNotifier()

bool

addNotification(const Path & path, ChangeDelegate callback)

Adds a file change notification.
bool

isNotifying()

Returns true if the notifier is enabled and file change notifications will be sent.
bool

removeNotification(const Path & path, ChangeDelegate callback)

Removes an existing file change notification.
void

startNotifier()

void

stopNotifier()

Protected Functions
String

cleanPath(const Path & dir)

Makes sure paths going in and out of the notifier will have the same format.
bool

internalAddNotification(const Path & dir)

This is called so the inherited class can do its own bookkeeping on addNotification()
void

internalNotifyDirChanged(const Path & dir)

Called by the inherited class to let us know a directory has changed so we can find the file which changed and notify on it.
void

internalProcessOnce()

bool

internalRemoveNotification(const Path & dir)

This is called so the inherited class can do its own bookkeeping on removeNotification()
void

process()

Detailed Description
Public Types
typedef Delegate< void(const Path &)> ChangeDelegate 

typedef Signal< void(const Path &)> ChangeSignal 

Protected Types
typedef Map< Path, FileInfoList > DirMap 

map a directory to a list of files and their mod times
typedef List< FileInfo > FileInfoList 

Protected Attributes
DirMap mDirMap 

FileSystem * mFS 

bool mNotifying 

Public Functions
FileSystemChangeNotifier(FileSystem * fs)

~FileSystemChangeNotifier()

addNotification(const Path & path, ChangeDelegate callback)

Adds a file change notification.
see:
FS::AddChangeNotification
Reimplemented by: Torque::FileSystemRedirectChangeNotifier
isNotifying()

Returns true if the notifier is enabled and file change notifications will be sent.
removeNotification(const Path & path, ChangeDelegate callback)

Removes an existing file change notification.
see:
FS::RemoveChangeNotification
Reimplemented by: Torque::FileSystemRedirectChangeNotifier
startNotifier()

stopNotifier()

Protected Functions
cleanPath(const Path & dir)

Makes sure paths going in and out of the notifier will have the same format.
internalAddNotification(const Path & dir)

This is called so the inherited class can do its own bookkeeping on addNotification()
note:
We pass the directory here, not the file
Reimplemented by: Torque::FileSystemRedirectChangeNotifier, Torque::Win32::Win32FileSystemChangeNotifier, MacFileSystemChangeNotifier
internalNotifyDirChanged(const Path & dir)

Called by the inherited class to let us know a directory has changed so we can find the file which changed and notify on it.
internalProcessOnce()

Reimplemented by: Torque::FileSystemRedirectChangeNotifier, MacFileSystemChangeNotifier, Torque::Win32::Win32FileSystemChangeNotifier
internalRemoveNotification(const Path & dir)

This is called so the inherited class can do its own bookkeeping on removeNotification()
note:
We pass the directory here, not the file
Reimplemented by: Torque::FileSystemRedirectChangeNotifier, Torque::Win32::Win32FileSystemChangeNotifier, MacFileSystemChangeNotifier
process()