FileWatcherCWrapper.cpp File Reference

#include <efsw/efsw.h>
#include <efsw/efsw.hpp>
#include <vector>

Include dependency graph for FileWatcherCWrapper.cpp:

Classes
class	Watcher_CAPI

Macros
#define	TOBOOL(i)   ((i) == 0 ? false : true)

Functions
Watcher_CAPI *	find_callback (efsw_watcher watcher, efsw_pfn_fileaction_callback fn)
Watcher_CAPI *	remove_callback (efsw_watcher watcher)
efsw_watcher	efsw_create (int generic_mode)
void	efsw_release (efsw_watcher watcher)
	Release the file-watcher and unwatch any directories. More...
const char *	efsw_getlasterror ()
	Retreive last error occured by file-watcher. More...
efsw_watchid	efsw_addwatch (efsw_watcher watcher, const char *directory, efsw_pfn_fileaction_callback callback_fn, int recursive, void *param)
void	efsw_removewatch (efsw_watcher watcher, const char *directory)
	Remove a directory watch. This is a brute force search O(nlogn). More...
void	efsw_removewatch_byid (efsw_watcher watcher, efsw_watchid watchid)
	Remove a directory watch. This is a map lookup O(logn). More...
void	efsw_watch (efsw_watcher watcher)
	Starts watching ( in other thread ) More...
void	efsw_follow_symlinks (efsw_watcher watcher, int enable)
int	efsw_follow_symlinks_isenabled (efsw_watcher watcher)
void	efsw_allow_outofscopelinks (efsw_watcher watcher, int allow)
int	efsw_outofscopelinks_isallowed (efsw_watcher watcher)

Variables
static std::vector < Watcher_CAPI * >	g_callbacks

Macro Definition Documentation

#define TOBOOL

(

i

)

((i) == 0 ? false : true)

Function Documentation

efsw_watchid efsw_addwatch	(	efsw_watcher	watcher,
		const char *	directory,
		efsw_pfn_fileaction_callback	callback_fn,
		int	recursive,
		void *	param
	)

Add a directory watch. Same as the other addWatch, but doesn't have recursive option. For backwards compatibility. On error returns WatchID with Error type.

{
 Watcher_CAPI* callback = find_callback(watcher, callback_fn);

 if (callback == NULL) {
 callback = new Watcher_CAPI(watcher, callback_fn, param);
 g_callbacks.push_back(callback);
 }

 return ((efsw::FileWatcher*)watcher)->addWatch(std::string(directory), callback,
 TOBOOL(recursive));
}

Here is the call graph for this function:

void efsw_allow_outofscopelinks	(	efsw_watcher	watcher,
		int	allow
	)

When enable this it will allow symlinks to watch recursively out of the pointed directory. follorSymlinks must be enabled to this work. For example, added symlink to /home/folder, and the symlink points to /, this by default is not allowed, it's only allowed to symlink anything from /home/ and deeper. This is to avoid great levels of recursion. Enabling this could lead in infinite recursion, and crash the watcher ( it will try not to avoid this ). Buy enabling out of scope links, it will allow this behavior. allowOutOfScopeLinks are disabled by default.

{
 ((efsw::FileWatcher*)watcher)->allowOutOfScopeLinks(TOBOOL(allow));
}

efsw_watcher efsw_create

(

int

generic_mode

)

Creates a new file-watcher

Parameters

generic_mode

Force the use of the Generic file watcher

{
 return (efsw_watcher)new efsw::FileWatcher(TOBOOL(generic_mode));
}

void efsw_follow_symlinks	(	efsw_watcher	watcher,
		int	enable
	)

Allow recursive watchers to follow symbolic links to other directories followSymlinks is disabled by default

{
 ((efsw::FileWatcher*)watcher)->followSymlinks(TOBOOL(enable));
}

int efsw_follow_symlinks_isenabled

(

efsw_watcher

watcher

)

Returns

If can follow symbolic links to directorioes

{
 return (int)((efsw::FileWatcher*)watcher)->followSymlinks();
}

const char* efsw_getlasterror

(

)

Retreive last error occured by file-watcher.

{
 static std::string log_str;
 log_str = efsw::Errors::Log::getLastErrorLog();
 return log_str.c_str();
}

int efsw_outofscopelinks_isallowed

(

efsw_watcher

watcher

)

Returns

Returns if out of scope links are allowed

{
 return (int)((efsw::FileWatcher*)watcher)->allowOutOfScopeLinks();
}

void efsw_release

(

efsw_watcher

watcher

)

Release the file-watcher and unwatch any directories.

{
 remove_callback(watcher);
 delete (efsw::FileWatcher*)watcher;
}

Here is the call graph for this function:

void efsw_removewatch	(	efsw_watcher	watcher,
		const char *	directory
	)

Remove a directory watch. This is a brute force search O(nlogn).

{
 ((efsw::FileWatcher*)watcher)->removeWatch(std::string(directory));
}

void efsw_removewatch_byid	(	efsw_watcher	watcher,
		efsw_watchid	watchid
	)

Remove a directory watch. This is a map lookup O(logn).

{
 ((efsw::FileWatcher*)watcher)->removeWatch(watchid);
}

void efsw_watch

(

efsw_watcher

watcher

)

Starts watching ( in other thread )

{
 ((efsw::FileWatcher*)watcher)->watch();
}

Watcher_CAPI* find_callback	(	efsw_watcher	watcher,
		efsw_pfn_fileaction_callback	fn
	)

{
 for (std::vector<Watcher_CAPI*>::iterator i = g_callbacks.begin(); i != g_callbacks.end(); i++ )
 {
 Watcher_CAPI* callback = *i;

 if (callback->mFn == fn && callback->mWatcher == watcher)
 return *i;
 }

 return NULL;
}

Here is the caller graph for this function:

Watcher_CAPI* remove_callback

(

efsw_watcher

watcher

)

{
 std::vector<Watcher_CAPI*>::iterator i = g_callbacks.begin();

 while (i != g_callbacks.end()) {
 Watcher_CAPI* callback = *i;

 if (callback->mWatcher == watcher)
 i = g_callbacks.erase(i);
 else
 i++;
 }

 return NULL;
}

Here is the caller graph for this function:

Variable Documentation

std::vector<Watcher_CAPI*> g_callbacks

static