File Access Monitoring

This section contains file access monitoring routines. More...

Data Structures
struct	ruFamEvent_

Macros
#define	RU_FAM_CREATED   0x001
#define	RU_FAM_DELETED   0x002
#define	RU_FAM_MODIFIED   0x004
#define	RU_FAM_MOVED   0x008
#define	RU_FAM_ATTRIB   0x010
#define	RU_FAM_KILL_TIMEOUT   5
#define	RU_FAM_POLL_TIMEOUT   250
#define	RU_FAM_QUEUE_TIMEOUT   50
#define	ruFamEventLog(lvl, fe, prefix)

Typedefs
typedef struct ruFamEvent_	ruFamEvent
typedef void(*	ruFamHandler) (ruFamEvent *fe, perm_ptr ctx)
typedef void *	ruFamCtx

Functions
RUAPI ruFamCtx	ruFamMonitorFilePath (trans_chars filePath, trans_chars threadName, ruFamHandler eventCallBack, perm_ptr ctx)
RUAPI ruFamCtx	ruFamKillMonitor (ruFamCtx o)
RUAPI bool	ruFamQuit (ruFamCtx o)
RUAPI const char *	ruFamEventTypeString (int32_t action)
RUAPI void	ruFamLogEventFunc (uint32_t loglevel, trans_chars file, trans_chars func, int32_t line, ruFamEvent *fe, trans_chars prefix)
RUAPI char *	ruFamEventString (ruFamEvent *fe)
RUAPI ruFamEvent *	ruFamEventNew (int eventType, trans_chars filePath, trans_chars destPath)
RUAPI ptr	ruFamEventFree (ptr o)

Detailed Description

This section contains file access monitoring routines.

Example:

void myfamHandler(ruFamEvent* fe, perm_ptr ctx) {
    ruFamEventLog(RU_LOG_VERB, fe, "got");
    // important to free this
    ruFamEventFree(fe);
}
 
ruFamCtx famCtx = ruFamMonitorFilePath(
        "/some/dir","test",
        myfamHandler, NULL);
// run your program...
ruFamKillMonitor(famCtx);

Macro Definition Documentation

RU_FAM_ATTRIB

#define RU_FAM_ATTRIB   0x010

File meta data changed

RU_FAM_CREATED

#define RU_FAM_CREATED   0x001

File was created

RU_FAM_DELETED

#define RU_FAM_DELETED   0x002

File was deleted

RU_FAM_KILL_TIMEOUT

#define RU_FAM_KILL_TIMEOUT   5

seconds to wait before hard kill

RU_FAM_MODIFIED

#define RU_FAM_MODIFIED   0x004

File was modified

RU_FAM_MOVED

#define RU_FAM_MOVED   0x008

File was moved or renamed

RU_FAM_POLL_TIMEOUT

#define RU_FAM_POLL_TIMEOUT   250

to wait when no events are pending

RU_FAM_QUEUE_TIMEOUT

#define RU_FAM_QUEUE_TIMEOUT   50

to wait when events (like moves) are pending

ruFamEventLog

#define ruFamEventLog	(		lvl,
			fe,
			prefix
	)

Value:

    ruMacStart { \
    if(ruDoesLog(lvl)) { \
        ruFamLogEventFunc(lvl, __FILE__, __func__, __LINE__, fe, prefix); \
    } \
} ruMacEnd

Log string representation of famEvent

Parameters

lvl	Log level of this message.
fe	famEvent tp log
prefix	optional prefix message

Typedef Documentation

ruFamCtx

typedef void* ruFamCtx

Opaque internal fam context pointer

ruFamEvent

typedef struct ruFamEvent_ ruFamEvent

ruFamHandler

typedef void(* ruFamHandler) (ruFamEvent *fe, perm_ptr ctx)

Signature of call back event handler

Parameters

fe	ruFamEvent to process. Caller must free with ruFamEventFree
ctx	User defined context passed in with ruFamMonitorFilePath

Function Documentation

ruFamEventFree()

RUAPI ptr ruFamEventFree

(

ptr

o

)

famEvent destructor

Parameters

o	famEvent to free

Returns

NULL

ruFamEventNew()

RUAPI ruFamEvent* ruFamEventNew	(	int	eventType,
		trans_chars	filePath,
		trans_chars	destPath
	)

famEvent Constructor

Parameters

eventType	event type
filePath	file path
destPath	optional destination path

Returns

famEvent free with ruFamEventFree after use

ruFamEventString()

RUAPI char* ruFamEventString

(

ruFamEvent *

fe

)

String representation of famEvent

Parameters

fe	event tp print out

Returns

string to be freed after use

ruFamEventTypeString()

RUAPI const char* ruFamEventTypeString

(

int32_t

action

)

Return string representation of the event type code

Parameters

action

eventType

Returns

string representating the given eventType. User must not free this.

ruFamKillMonitor()

RUAPI ruFamCtx ruFamKillMonitor

(

ruFamCtx

o

)

This function stop the thread started by ruFamMonitorFilePath and closes the associated monitor handles.

Parameters

o	famObj to kill

Returns

NULL

ruFamLogEventFunc()

RUAPI void ruFamLogEventFunc	(	uint32_t	loglevel,
		trans_chars	file,
		trans_chars	func,
		int32_t	line,
		ruFamEvent *	fe,
		trans_chars	prefix
	)

Internal logging function used by ruFamEventLog

Parameters

loglevel	Log level of this message.
file	FILE
func	func
line	LINE
fe	famE vent tp log
prefix	optional prefix message

ruFamMonitorFilePath()

RUAPI ruFamCtx ruFamMonitorFilePath	(	trans_chars	filePath,
		trans_chars	threadName,
		ruFamHandler	eventCallBack,
		perm_ptr	ctx
	)

This function creates a new thread that recursively watches filePath and below and calls eventCallBack with events.

Parameters

filePath	Filepath to monitor.
threadName	The name that the new thread should go by in the logs
eventCallBack	callback that will process given event
ctx	user defined data that is then passed to the given eventCallBack along with the event.

Returns

ruFamQuit()

RUAPI bool ruFamQuit

(

ruFamCtx

o

)

Reports whether fam is in a running state or not

Parameters

o	famObj to check

Returns

false if fam is running