TrinityCore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
efsw.h File Reference
+ This graph shows which files directly or indirectly include this file:

Go to the source code of 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

Copyright (c) 2013 Martin Lucas Golini

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

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.

69 {
70  EFSW_ADD = 1,
71  EFSW_DELETE = 2,
72  EFSW_MODIFIED = 3,
73  EFSW_MOVED = 4
74 };
Definition: efsw.h:70
Sent when a file is deleted or renamed.
Definition: efsw.h:72
Sent when a file is created or renamed.
Definition: efsw.h:71
Sent when a file is modified.
Definition: efsw.h:73
enum efsw_error
Enumerator
EFSW_NOTFOUND 
EFSW_REPEATED 
EFSW_OUTOFSCOPE 
EFSW_NOTREADABLE 
EFSW_REMOTE 
EFSW_UNSPECIFIED 
77 {
78  EFSW_NOTFOUND = -1,
79  EFSW_REPEATED = -2,
80  EFSW_OUTOFSCOPE = -3,
81  EFSW_NOTREADABLE = -4,
82  EFSW_REMOTE = -5,
83  EFSW_UNSPECIFIED = -6
84 };
Definition: efsw.h:79
Definition: efsw.h:83
Definition: efsw.h:81
Definition: efsw.h:78
Definition: efsw.h:80
Definition: efsw.h:82

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.

86 {
87  Watcher_CAPI* callback = find_callback(watcher, callback_fn);
88 
89  if (callback == NULL) {
90  callback = new Watcher_CAPI(watcher, callback_fn, param);
91  g_callbacks.push_back(callback);
92  }
93 
94  return ((efsw::FileWatcher*)watcher)->addWatch(std::string(directory), callback,
95  TOBOOL(recursive));
96 }
static std::vector< Watcher_CAPI * > g_callbacks
Definition: FileWatcherCWrapper.cpp:33
Definition: FileWatcherCWrapper.cpp:8
#define TOBOOL(i)
Definition: FileWatcherCWrapper.cpp:5
arena_t NULL
Definition: jemalloc_internal.h:624
Watcher_CAPI * find_callback(efsw_watcher watcher, efsw_pfn_fileaction_callback fn)
Definition: FileWatcherCWrapper.cpp:35

+ 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.

124 {
125  ((efsw::FileWatcher*)watcher)->allowOutOfScopeLinks(TOBOOL(allow));
126 }
#define TOBOOL(i)
Definition: FileWatcherCWrapper.cpp:5
efsw_watcher EFSW_API efsw_create ( int  generic_mode)

Creates a new file-watcher

Parameters
generic_modeForce the use of the Generic file watcher
67 {
68  return (efsw_watcher)new efsw::FileWatcher(TOBOOL(generic_mode));
69 }
#define TOBOOL(i)
Definition: FileWatcherCWrapper.cpp:5
void * efsw_watcher
Type for watcher.
Definition: efsw.h:66
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

114 {
115  ((efsw::FileWatcher*)watcher)->followSymlinks(TOBOOL(enable));
116 }
#define TOBOOL(i)
Definition: FileWatcherCWrapper.cpp:5
int EFSW_API efsw_follow_symlinks_isenabled ( efsw_watcher  watcher)
Returns
If can follow symbolic links to directorioes
119 {
120  return (int)((efsw::FileWatcher*)watcher)->followSymlinks();
121 }
EFSW_API const char* efsw_getlasterror ( )

Retreive last error occured by file-watcher.

78 {
79  static std::string log_str;
80  log_str = efsw::Errors::Log::getLastErrorLog();
81  return log_str.c_str();
82 }
int EFSW_API efsw_outofscopelinks_isallowed ( efsw_watcher  watcher)
Returns
Returns if out of scope links are allowed
129 {
130  return (int)((efsw::FileWatcher*)watcher)->allowOutOfScopeLinks();
131 }
void EFSW_API efsw_release ( efsw_watcher  watcher)

Release the file-watcher and unwatch any directories.

72 {
73  remove_callback(watcher);
74  delete (efsw::FileWatcher*)watcher;
75 }
Watcher_CAPI * remove_callback(efsw_watcher watcher)
Definition: FileWatcherCWrapper.cpp:48

+ 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).

99 {
100  ((efsw::FileWatcher*)watcher)->removeWatch(std::string(directory));
101 }
void EFSW_API efsw_removewatch_byid ( efsw_watcher  watcher,
efsw_watchid  watchid 
)

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

104 {
105  ((efsw::FileWatcher*)watcher)->removeWatch(watchid);
106 }
void EFSW_API efsw_watch ( efsw_watcher  watcher)

Starts watching ( in other thread )

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