fawkes::FamListener Class Reference

File Alteration Monitor Listener. More...

#include <utils/system/fam.h>

Inheritance diagram for fawkes::FamListener:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~FamListener ()
 Virtual empty destructor.
virtual void fam_event (const char *filename, unsigned int mask)=0
 Event has been raised.

Static Public Attributes

static const unsigned int FAM_ACCESS = 0x00000001
 File was accessed.
static const unsigned int FAM_MODIFY = 0x00000002
 File was modified.
static const unsigned int FAM_ATTRIB = 0x00000004
 Metadata changed.
static const unsigned int FAM_CLOSE_WRITE = 0x00000008
 Writtable file was closed.
static const unsigned int FAM_CLOSE_NOWRITE = 0x00000010
 Unwrittable file closed.
static const unsigned int FAM_CLOSE = (FAM_CLOSE_WRITE | FAM_CLOSE_NOWRITE)
 Close.
static const unsigned int FAM_OPEN = 0x00000020
 File was opened.
static const unsigned int FAM_MOVED_FROM = 0x00000040
 File was moved from X.
static const unsigned int FAM_MOVED_TO = 0x00000080
 File was moved to Y.
static const unsigned int FAM_MOVE = (FAM_MOVED_FROM | FAM_MOVED_TO)
 Moves.
static const unsigned int FAM_CREATE = 0x00000100
 Subfile was created.
static const unsigned int FAM_DELETE = 0x00000200
 Subfile was deleted.
static const unsigned int FAM_DELETE_SELF = 0x00000400
 Self was deleted.
static const unsigned int FAM_MOVE_SELF = 0x00000800
 Self was moved.
static const unsigned int FAM_UNMOUNT = 0x00002000
 Backing fs was unmounted.
static const unsigned int FAM_Q_OVERFLOW = 0x00004000
 Event queued overflowed.
static const unsigned int FAM_IGNORED = 0x00008000
 File was ignored.
static const unsigned int FAM_ONLYDIR = 0x01000000
 Only watch the path if it is a directory.
static const unsigned int FAM_DONT_FOLLOW = 0x02000000
 Do not follow a sym link.
static const unsigned int FAM_MASK_ADD = 0x20000000
 Add to the mask of an already existing watch.
static const unsigned int FAM_ISDIR = 0x40000000
 Event occurred against dir.
static const unsigned int FAM_ONESHOT = 0x80000000
 Only send event once.
static const unsigned int FAM_ALL_EVENTS
 All events which a program can wait on.

Detailed Description

File Alteration Monitor Listener.

Listener called by FileAlterationMonitor for events.

Author:
Tim Niemueller

Definition at line 35 of file fam.h.


Constructor & Destructor Documentation

fawkes::FamListener::~FamListener (  )  [virtual]

Virtual empty destructor.

Definition at line 415 of file fam.cpp.


Member Function Documentation

fawkes::FamListener::fam_event ( const char *  filename,
unsigned int  mask 
) [pure virtual]

Event has been raised.

Parameters:
filename name of the file that triggered the event
mask mask indicating the event. Currently inotify event flags are used, see inotify.h.

Implemented in fawkes::LuaContext, and fawkes::PluginManager.


Member Data Documentation

const unsigned int fawkes::FamListener::FAM_ACCESS = 0x00000001 [static]

File was accessed.

Definition at line 40 of file fam.h.

const unsigned int fawkes::FamListener::FAM_ALL_EVENTS [static]
Initial value:

All events which a program can wait on.

Definition at line 65 of file fam.h.

const unsigned int fawkes::FamListener::FAM_ATTRIB = 0x00000004 [static]

Metadata changed.

Definition at line 42 of file fam.h.

Close.

Definition at line 45 of file fam.h.

const unsigned int fawkes::FamListener::FAM_CLOSE_NOWRITE = 0x00000010 [static]

Unwrittable file closed.

Definition at line 44 of file fam.h.

const unsigned int fawkes::FamListener::FAM_CLOSE_WRITE = 0x00000008 [static]

Writtable file was closed.

Definition at line 43 of file fam.h.

const unsigned int fawkes::FamListener::FAM_CREATE = 0x00000100 [static]

Subfile was created.

Definition at line 50 of file fam.h.

Referenced by fawkes::PluginManager::fam_event().

const unsigned int fawkes::FamListener::FAM_DELETE = 0x00000200 [static]

Subfile was deleted.

Definition at line 51 of file fam.h.

Referenced by fawkes::PluginManager::fam_event().

const unsigned int fawkes::FamListener::FAM_DELETE_SELF = 0x00000400 [static]

Self was deleted.

Definition at line 52 of file fam.h.

const unsigned int fawkes::FamListener::FAM_DONT_FOLLOW = 0x02000000 [static]

Do not follow a sym link.

Definition at line 60 of file fam.h.

const unsigned int fawkes::FamListener::FAM_IGNORED = 0x00008000 [static]

File was ignored.

Definition at line 57 of file fam.h.

const unsigned int fawkes::FamListener::FAM_ISDIR = 0x40000000 [static]

Event occurred against dir.

Definition at line 62 of file fam.h.

Referenced by fawkes::PluginManager::fam_event().

const unsigned int fawkes::FamListener::FAM_MASK_ADD = 0x20000000 [static]

Add to the mask of an already existing watch.

Definition at line 61 of file fam.h.

const unsigned int fawkes::FamListener::FAM_MODIFY = 0x00000002 [static]

File was modified.

Definition at line 41 of file fam.h.

Referenced by fawkes::PluginManager::fam_event().

const unsigned int fawkes::FamListener::FAM_MOVE = (FAM_MOVED_FROM | FAM_MOVED_TO) [static]

Moves.

Definition at line 49 of file fam.h.

const unsigned int fawkes::FamListener::FAM_MOVE_SELF = 0x00000800 [static]

Self was moved.

Definition at line 53 of file fam.h.

const unsigned int fawkes::FamListener::FAM_MOVED_FROM = 0x00000040 [static]

File was moved from X.

Definition at line 47 of file fam.h.

Referenced by fawkes::PluginManager::fam_event().

const unsigned int fawkes::FamListener::FAM_MOVED_TO = 0x00000080 [static]

File was moved to Y.

Definition at line 48 of file fam.h.

Referenced by fawkes::PluginManager::fam_event().

const unsigned int fawkes::FamListener::FAM_ONESHOT = 0x80000000 [static]

Only send event once.

Definition at line 63 of file fam.h.

const unsigned int fawkes::FamListener::FAM_ONLYDIR = 0x01000000 [static]

Only watch the path if it is a directory.

Definition at line 59 of file fam.h.

const unsigned int fawkes::FamListener::FAM_OPEN = 0x00000020 [static]

File was opened.

Definition at line 46 of file fam.h.

const unsigned int fawkes::FamListener::FAM_Q_OVERFLOW = 0x00004000 [static]

Event queued overflowed.

Definition at line 56 of file fam.h.

const unsigned int fawkes::FamListener::FAM_UNMOUNT = 0x00002000 [static]

Backing fs was unmounted.

Definition at line 55 of file fam.h.


The documentation for this class was generated from the following files:

Generated on 1 Mar 2011 for Fawkes API by  doxygen 1.6.1