#include "lib/os_path.h"
#include <vector>
#include <memory>
Go to the source code of this file.
◆ DirWatchNotifications
◆ PDirWatch
◆ dir_watch_Add()
start watching a single directory for changes.
- Parameters
-
path | (must end in slash) |
dirWatch | opaque smart pointer to the watch state; used to manage its lifetime (this is deemed more convenient than a separate dir_watch_Remove interface). |
clients typically want to watch entire directory subtrees (e.g. a mod), which is supported by Windows but not FAM. to reduce overhead, the Windows backend always watches subtrees, but portable clients should still add a watch for each subdirectory (the shared watch state is reference-counted). rationale: since the VFS has per-directory data structures, it is convenient to store PDirWatch there instead of creating a second tree structure here.
◆ dir_watch_Poll()
return all pending directory watch notifications.
- Parameters
-
notifications | receives any pending notifications in unspecified order. |
- Returns
- Status (INFO::OK doesn't imply notifications were returned)
note: the run time of this function is independent of the number of directory watches and number of files.
rationale for a polling interface: users (e.g. the main game loop) typically want to receive change notifications at a single point, rather than deal with the complexity of asynchronous notifications.