Tracker Filesystem Miner

Synopsis


#include <libtracker-miner/tracker-miner-fs.h>

typedef             TrackerMinerFS;
typedef             TrackerMinerFSClass;
void                (*TrackerMinerFSDoneCb)             (TrackerMinerFS *fs,
                                                         GFile *file,
                                                         TrackerSparqlBuilder *builder,
                                                         const GError *error,
                                                         gpointer user_data);
void                tracker_miner_fs_add_directory      (TrackerMinerFS *fs,
                                                         GFile *file,
                                                         gboolean recurse);
gboolean            tracker_miner_fs_remove_directory   (TrackerMinerFS *fs,
                                                         GFile *file);
void                tracker_miner_fs_set_throttle       (TrackerMinerFS *fs,
                                                         gdouble throttle);
gdouble             tracker_miner_fs_get_throttle       (TrackerMinerFS *fs);

Object Hierarchy

  GObject
   +----TrackerMiner
         +----TrackerMinerFS

Properties

  "throttle"                 gdouble               : Read / Write

Signals

  "check-directory"                                : Run Last
  "check-directory-contents"                       : Run Last
  "check-file"                                     : Run Last
  "finished"                                       : Run Last
  "monitor-directory"                              : Run Last

Description

Details

TrackerMinerFS

typedef struct TrackerMinerFS        TrackerMinerFS;

TrackerMinerFSClass

typedef struct TrackerMinerFSClass   TrackerMinerFSClass;

TrackerMinerFSDoneCb ()

void                (*TrackerMinerFSDoneCb)             (TrackerMinerFS *fs,
                                                         GFile *file,
                                                         TrackerSparqlBuilder *builder,
                                                         const GError *error,
                                                         gpointer user_data);

`fs` :
`file` :
`builder` :
`error` :
`user_data` :

tracker_miner_fs_add_directory ()

void                tracker_miner_fs_add_directory      (TrackerMinerFS *fs,
                                                         GFile *file,
                                                         gboolean recurse);

Tells the filesystem miner to inspect a directory.

`fs` :	a TrackerMinerFS
`file` :	GFile for the directory to inspect
`recurse` :	whether the directory should be inspected recursively

tracker_miner_fs_remove_directory ()

gboolean            tracker_miner_fs_remove_directory   (TrackerMinerFS *fs,
                                                         GFile *file);

Removes a directory from being inspected by fs.

`fs` :	a TrackerMinerFS
`file` :	GFile for the directory to be removed
Returns :	`TRUE` if the directory was successfully removed.

tracker_miner_fs_set_throttle ()

void                tracker_miner_fs_set_throttle       (TrackerMinerFS *fs,
                                                         gdouble throttle);

Tells the filesystem miner to throttle its operations. a value of 0 means no throttling at all, so the miner will perform operations at full speed, 1 is the slowest value.

`fs` :	a TrackerMinerFS
`throttle` :	throttle value, between 0 and 1

tracker_miner_fs_get_throttle ()

gdouble             tracker_miner_fs_get_throttle       (TrackerMinerFS *fs);

Gets the current throttle value. see tracker_miner_fs_set_throttle().

`fs` :	a TrackerMinerFS
Returns :	current throttle value.

Property Details

The `"throttle"` property

  "throttle"                 gdouble               : Read / Write

Modifier for the indexing speed, 0 is max speed.

Allowed values: [0,1]

Default value: 0

Signal Details

The `"check-directory"` signal

gboolean            user_function                      (TrackerMinerFS *trackerminerfs,
                                                        GFile          *arg1,
                                                        gpointer        user_data)           : Run Last

`trackerminerfs` :	the object which received the signal.
`arg1` :
`user_data` :	user data set when the signal handler was connected.
Returns :

The `"check-directory-contents"` signal

gboolean            user_function                      (TrackerMinerFS *trackerminerfs,
                                                        GFile          *arg1,
                                                        gpointer        arg2,
                                                        gpointer        user_data)           : Run Last

`trackerminerfs` :	the object which received the signal.
`arg1` :
`arg2` :
`user_data` :	user data set when the signal handler was connected.
Returns :

The `"check-file"` signal

gboolean            user_function                      (TrackerMinerFS *trackerminerfs,
                                                        GFile          *arg1,
                                                        gpointer        user_data)           : Run Last

`trackerminerfs` :	the object which received the signal.
`arg1` :
`user_data` :	user data set when the signal handler was connected.
Returns :

The `"finished"` signal

void                user_function                      (TrackerMinerFS *trackerminerfs,
                                                        gdouble         arg1,
                                                        guint           arg2,
                                                        guint           arg3,
                                                        guint           arg4,
                                                        guint           arg5,
                                                        gpointer        user_data)           : Run Last

`trackerminerfs` :	the object which received the signal.
`arg1` :
`arg2` :
`arg3` :
`arg4` :
`arg5` :
`user_data` :	user data set when the signal handler was connected.

The `"monitor-directory"` signal

gboolean            user_function                      (TrackerMinerFS *trackerminerfs,
                                                        GFile          *arg1,
                                                        gpointer        user_data)           : Run Last

`trackerminerfs` :	the object which received the signal.
`arg1` :
`user_data` :	user data set when the signal handler was connected.
Returns :

			Tracker Miner Library Reference Manual
Top \| Description \| Object Hierarchy \| Properties \| Signals