Tracker Miner

Tracker Miner

Synopsis


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

typedef             TrackerMiner;
typedef             TrackerMinerClass;
GQuark              tracker_miner_error_quark           (void);
void                tracker_miner_start                 (TrackerMiner *miner);
void                tracker_miner_stop                  (TrackerMiner *miner);
gboolean            tracker_miner_is_started            (TrackerMiner *miner);
gboolean            tracker_miner_execute_update        (TrackerMiner *miner,
                                                         const gchar *sparql,
                                                         GError **error);
GPtrArray *         tracker_miner_execute_sparql        (TrackerMiner *miner,
                                                         const gchar *sparql,
                                                         GError **error);
gboolean            tracker_miner_execute_batch_update  (TrackerMiner *miner,
                                                         const gchar *sparql,
                                                         GError **error);
gboolean            tracker_miner_commit                (TrackerMiner *miner);
gint                tracker_miner_pause                 (TrackerMiner *miner,
                                                         const gchar *application,
                                                         const gchar *reason,
                                                         GError **error);
gboolean            tracker_miner_resume                (TrackerMiner *miner,
                                                         gint cookie,
                                                         GError **error);

Object Hierarchy

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

Properties

  "name"                     gchar*                : Read / Write / Construct Only
  "progress"                 gdouble               : Read / Write
  "status"                   gchar*                : Read / Write

Signals

  "error"                                          : Run Last
  "paused"                                         : Run Last
  "progress"                                       : Run Last
  "resumed"                                        : Run Last
  "started"                                        : Run Last
  "stopped"                                        : Run Last
  "terminated"                                     : Run Last

Description

Details

TrackerMiner

typedef struct TrackerMiner TrackerMiner;


TrackerMinerClass

typedef struct TrackerMinerClass TrackerMinerClass;


tracker_miner_error_quark ()

GQuark              tracker_miner_error_quark           (void);

Returns the GQuark used to identify miner errors in GError structures.

Returns :

the error GQuark

tracker_miner_start ()

void                tracker_miner_start                 (TrackerMiner *miner);

Tells the miner to start processing data.

miner :

a TrackerMiner

tracker_miner_stop ()

void                tracker_miner_stop                  (TrackerMiner *miner);

Tells the miner to stop processing data.

miner :

a TrackerMiner

tracker_miner_is_started ()

gboolean            tracker_miner_is_started            (TrackerMiner *miner);

Returns TRUE if the miner has been started.

miner :

a TrackerMiner

Returns :

TRUE if the miner is already started.

tracker_miner_execute_update ()

gboolean            tracker_miner_execute_update        (TrackerMiner *miner,
                                                         const gchar *sparql,
                                                         GError **error);

Executes an update SPARQL query on tracker-store, use this whenever you want to perform data insertions or modifications.

miner :

a TrackerMiner

sparql :

a SPARQL query

error :

return location for errors

Returns :

TRUE if the SPARQL query was executed successfully.

tracker_miner_execute_sparql ()

GPtrArray *         tracker_miner_execute_sparql        (TrackerMiner *miner,
                                                         const gchar *sparql,
                                                         GError **error);

Executes the SPARQL query on tracker-store and returns the queried data. Use this whenever you need to get data from already stored information.

miner :

a TrackerMiner

sparql :

a SPARQL query

error :

return location for errors

Returns :

a GPtrArray with the returned data.

tracker_miner_execute_batch_update ()

gboolean            tracker_miner_execute_batch_update  (TrackerMiner *miner,
                                                         const gchar *sparql,
                                                         GError **error);

Executes a batch of update SPARQL queries on tracker-store, use this whenever you want to perform data insertions or modifications in batches.

miner :

a TrackerMiner

sparql :

a set of SPARQL updates

error :

return location for errors

Returns :

TRUE if the SPARQL query was executed successfully.

tracker_miner_commit ()

gboolean            tracker_miner_commit                (TrackerMiner *miner);

Commits all pending batch updates. see tracker_miner_execute_batch_update()

miner :

a TrackerMiner

Returns :

TRUE if the data was committed successfully.

tracker_miner_pause ()

gint                tracker_miner_pause                 (TrackerMiner *miner,
                                                         const gchar *application,
                                                         const gchar *reason,
                                                         GError **error);

miner :

application :

reason :

error :

Returns :


tracker_miner_resume ()

gboolean            tracker_miner_resume                (TrackerMiner *miner,
                                                         gint cookie,
                                                         GError **error);

Asks the miner to resume processing. The cookie must be something returned by tracker_miner_pause(). The miner won't actually resume operations until all pause requests have been resumed.

miner :

a TrackerMiner

cookie :

pause cookie

error :

return location for errors

Returns :

TRUE if the cookie was valid.

Property Details

The "name" property

  "name"                     gchar*                : Read / Write / Construct Only

Name.

Default value: NULL


The "progress" property

  "progress"                 gdouble               : Read / Write

Progress (between 0 and 1).

Allowed values: [0,1]

Default value: 0


The "status" property

  "status"                   gchar*                : Read / Write

Status (unique to each miner).

Default value: NULL

Signal Details

The "error" signal

void                user_function                      (TrackerMiner *trackerminer,
                                                        gpointer      arg1,
                                                        gpointer      user_data)         : Run Last

trackerminer :

the object which received the signal.

arg1 :

user_data :

user data set when the signal handler was connected.

The "paused" signal

void                user_function                      (TrackerMiner *trackerminer,
                                                        gpointer      user_data)         : Run Last

trackerminer :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "progress" signal

void                user_function                      (TrackerMiner *trackerminer,
                                                        gchar        *arg1,
                                                        gdouble       arg2,
                                                        gpointer      user_data)         : Run Last

trackerminer :

the object which received the signal.

arg1 :

arg2 :

user_data :

user data set when the signal handler was connected.

The "resumed" signal

void                user_function                      (TrackerMiner *trackerminer,
                                                        gpointer      user_data)         : Run Last

trackerminer :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "started" signal

void                user_function                      (TrackerMiner *trackerminer,
                                                        gpointer      user_data)         : Run Last

trackerminer :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "stopped" signal

void                user_function                      (TrackerMiner *trackerminer,
                                                        gpointer      user_data)         : Run Last

trackerminer :

the object which received the signal.

user_data :

user data set when the signal handler was connected.

The "terminated" signal

void                user_function                      (TrackerMiner *trackerminer,
                                                        gpointer      user_data)         : Run Last

trackerminer :

the object which received the signal.

user_data :

user data set when the signal handler was connected.