Pyrogenesis  trunk
Classes | Typedefs | Functions | Variables
dir_watch_inotify.cpp File Reference
#include "precompiled.h"
#include "lib/sysdep/dir_watch.h"
#include "lib/sysdep/sysdep.h"
#include "ps/CLogger.h"
#include <map>
#include <string>
#include <sys/inotify.h>
Include dependency graph for dir_watch_inotify.cpp:

Classes

struct  NotificationEvent
 
struct  DirWatch
 

Typedefs

typedef std::map< int, PDirWatchDirWatchMap
 

Functions

static void inotify_deinit ()
 
static void inotify_event_loop_process_events ()
 
static void * inotify_event_loop (void *)
 
Status dir_watch_Add (const OsPath &path, PDirWatch &dirWatch)
 start watching a single directory for changes. More...
 
Status dir_watch_Poll (DirWatchNotifications &notifications)
 return all pending directory watch notifications. More...
 

Variables

static std::vector< NotificationEventg_notifications
 
static pthread_t g_event_loop_thread
 
static pthread_mutex_t g_mutex = PTHREAD_MUTEX_INITIALIZER
 
static int initialized = 0
 
static int inotifyfd
 
static DirWatchMap g_paths
 

Typedef Documentation

typedef std::map<int, PDirWatch> DirWatchMap

Function Documentation

Status dir_watch_Add ( const OsPath path,
PDirWatch dirWatch 
)

start watching a single directory for changes.

Parameters
path(must end in slash)
dirWatchopaque 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.

Status dir_watch_Poll ( DirWatchNotifications notifications)

return all pending directory watch notifications.

Parameters
notificationsreceives 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.

static void inotify_deinit ( )
static
static void* inotify_event_loop ( void *  )
static
static void inotify_event_loop_process_events ( )
static

Variable Documentation

pthread_t g_event_loop_thread
static
std::vector<NotificationEvent> g_notifications
static
DirWatchMap g_paths
static
int initialized = 0
static
int inotifyfd
static