This graph shows which files directly or indirectly include this file:

Macros
#define	EFSW_API

Typedefs
typedef long	efsw_watchid
	Type for a watch id. More...

typedef void *	efsw_watcher
	Type for watcher. More...

typedef void(*	efsw_pfn_fileaction_callback )(efsw_watcher watcher, efsw_watchid watchid, const char dir, const char filename, enum efsw_action action, const char old_filename, void param)
	Basic interface for listening for file events. More...

Enumerations
enum	efsw_action { EFSW_ADD = 1, EFSW_DELETE = 2, EFSW_MODIFIED = 3, EFSW_MOVED = 4 }

enum	efsw_error { EFSW_NOTFOUND = -1, EFSW_REPEATED = -2, EFSW_OUTOFSCOPE = -3, EFSW_NOTREADABLE = -4, EFSW_REMOTE = -5, EFSW_UNSPECIFIED = -6 }

Functions
efsw_watcher EFSW_API	efsw_create (int generic_mode)

void EFSW_API	efsw_release (efsw_watcher watcher)
	Release the file-watcher and unwatch any directories. More...

EFSW_API const char *	efsw_getlasterror ()
	Retreive last error occured by file-watcher. More...

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

void EFSW_API	efsw_removewatch (efsw_watcher watcher, const char *directory)
	Remove a directory watch. This is a brute force search O(nlogn). More...

void EFSW_API	efsw_removewatch_byid (efsw_watcher watcher, efsw_watchid watchid)
	Remove a directory watch. This is a map lookup O(logn). More...

void EFSW_API	efsw_watch (efsw_watcher watcher)
	Starts watching ( in other thread ) More...

void EFSW_API	efsw_follow_symlinks (efsw_watcher watcher, int enable)

int EFSW_API	efsw_follow_symlinks_isenabled (efsw_watcher watcher)

void EFSW_API	efsw_allow_outofscopelinks (efsw_watcher watcher, int allow)

int EFSW_API	efsw_outofscopelinks_isallowed (efsw_watcher watcher)

Macro Definition Documentation

#define EFSW_API

Author: Sepul Sepehr Taghdisian

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

This software is a fork of the "simplefilewatcher" by James Wynn (james.[email protected]@jam.[email protected]eswyn.[email protected]n.co.[email protected]m) http://code.google.com/p/simplefilewatcher/ also MIT licensed.This is the C API wrapper of EFSW

Typedef Documentation

typedef void(* efsw_pfn_fileaction_callback)(efsw_watcher watcher, efsw_watchid watchid, const char *dir, const char *filename, enum efsw_action action, const char *old_filename, void *param)

Basic interface for listening for file events.

typedef void* efsw_watcher

Type for watcher.

typedef long efsw_watchid

Type for a watch id.

Enumeration Type Documentation

enum efsw_action

Enumerator
EFSW_ADD
EFSW_DELETE	Sent when a file is created or renamed.
EFSW_MODIFIED	Sent when a file is deleted or renamed.
EFSW_MOVED	Sent when a file is modified.

 {
  EFSW_ADD = 1, 
  EFSW_DELETE = 2, 
  EFSW_MODIFIED = 3, 
  EFSW_MOVED = 4 
 };

enum efsw_error

Enumerator
EFSW_NOTFOUND
EFSW_REPEATED
EFSW_OUTOFSCOPE
EFSW_NOTREADABLE
EFSW_REMOTE
EFSW_UNSPECIFIED

 {
  EFSW_NOTFOUND = -1,
  EFSW_REPEATED = -2,
  EFSW_OUTOFSCOPE = -3,
  EFSW_NOTREADABLE = -4,
  EFSW_REMOTE = -5,
  EFSW_UNSPECIFIED = -6
 };

Function Documentation

efsw_watchid EFSW_API 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_API 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_API 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_API 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_API efsw_follow_symlinks_isenabled ( efsw_watcher watcher )

Returns: If can follow symbolic links to directorioes

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

EFSW_API 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_API efsw_outofscopelinks_isallowed ( efsw_watcher watcher )

Returns: Returns if out of scope links are allowed

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

void EFSW_API 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_API 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_API 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_API efsw_watch ( efsw_watcher watcher )

Starts watching ( in other thread )

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

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation