TrackerMinerFS

typedef struct TrackerMinerFS        TrackerMinerFS;

Abstract miner abstract implementation to get data from the filesystem.

TrackerMinerFSClass

typedef struct {
	TrackerMinerClass parent;

	gboolean (* check_file)            (TrackerMinerFS       *fs,
					    GFile                *file);
	gboolean (* check_directory)       (TrackerMinerFS       *fs,
					    GFile                *file);
	gboolean (* check_directory_contents) (TrackerMinerFS    *fs,
					       GFile             *parent,
					       GList             *children);
	gboolean (* process_file)          (TrackerMinerFS       *fs,
					    GFile                *file,
					    TrackerSparqlBuilder *builder,
					    GCancellable         *cancellable);
	gboolean (* monitor_directory)     (TrackerMinerFS       *fs,
					    GFile                *file);
	void     (* finished)              (TrackerMinerFS       *fs);
} TrackerMinerFSClass;

Prototype for the abstract class, check_file, check_directory, check_directory_contents, process_file and monitor_directory must be implemented in the deriving class in order to actually extract 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.

tracker_miner_fs_remove_directory ()

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

Removes a directory from being inspected by fs.

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.

tracker_miner_fs_get_throttle ()

gdouble             tracker_miner_fs_get_throttle       (TrackerMinerFS *fs);

Gets the current throttle value. see tracker_miner_fs_set_throttle().

tracker_miner_fs_notify_file ()

void                tracker_miner_fs_notify_file        (TrackerMinerFS *fs,
                                                         GFile *file,
                                                         const GError *error);

Notifies fs that all processing on file has been finished, if any error happened during file data processing, it should be passed in error, else that parameter will contain NULL to reflect success.

The "process-pool-limit" property

  "process-pool-limit"       guint                 : Read / Write / Construct

Number of files that can be concurrently processed.

Allowed values: >= 1

Default value: 1

The "throttle" property

  "throttle"                 gdouble               : Read / Write

Modifier for the indexing speed, 0 is max speed.

Allowed values: [0,1]

Default value: 0

The "check-directory" signal

gboolean            user_function                      (TrackerMinerFS *miner_fs,
                                                        GFile          *directory,
                                                        gpointer        user_data)      : Run Last

The ::check-directory signal is emitted either on the filesystem crawling phase or whenever a new directory appears in a monitored directory in order to check whether directory must be inspected my miner_fs.

The "check-directory-contents" signal

gboolean            user_function                      (TrackerMinerFS *miner_fs,
                                                        GFile          *directory,
                                                        gpointer        children,
                                                        gpointer        user_data)      : Run Last

The ::check-directory-contents signal is emitted either on the filesystem crawling phase or whenever a new directory appears in a monitored directory in order to check whether directory must be inspected my miner_fs based on the directory contents, for some implementations this signal may be useful to discard backup directories for example.

The "check-file" signal

gboolean            user_function                      (TrackerMinerFS *miner_fs,
                                                        GFile          *file,
                                                        gpointer        user_data)      : Run Last

The ::check-file signal is emitted either on the filesystem crawling phase or whenever a new file appears in a monitored directory in order to check whether file must be inspected my miner_fs.

The "finished" signal

void                user_function                      (TrackerMinerFS *miner_fs,
                                                        gdouble         elapsed,
                                                        guint           directories_found,
                                                        guint           directories_ignored,
                                                        guint           files_found,
                                                        guint           files_ignored,
                                                        gpointer        user_data)                : Run Last

The ::finished signal is emitted when miner_fs has finished all pending processing.

The "monitor-directory" signal

gboolean            user_function                      (TrackerMinerFS *miner_fs,
                                                        GFile          *directory,
                                                        gpointer        user_data)      : Run Last

The ::monitor-directory is emitted either on the filesystem crawling phase or whenever a new directory appears in a monitored directory in order to check whether directory must be monitored for filesystem changes or not.

The "process-file" signal

gboolean            user_function                      (TrackerMinerFS       *miner_fs,
                                                        GFile                *file,
                                                        TrackerSparqlBuilder *builder,
                                                        GCancellable         *cancellable,
                                                        gpointer              user_data)        : Run Last

The ::process-file signal is emitted whenever a file should be processed, and it's metadata extracted.

builder is the TrackerSparqlBuilder where all sparql updates to be performed for file will be appended.

This signal allows both synchronous and asynchronous extraction, in the synchronous case cancellable can be safely ignored. In either case, on successful metadata extraction, implementations must call tracker_miner_fs_notify_file() to indicate that processing has finished on file, so the miner can execute the SPARQL updates and continue processing other files.