summaryrefslogtreecommitdiff
path: root/src/libtracker-miner/tracker-crawler.h
blob: d99311e949381b6e8a963c401f77a5413b5e4448 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/*
 * Copyright (C) 2009, Nokia (urho.konttori@nokia.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA  02110-1301, USA.
 */

#ifndef __LIBTRACKERMINER_CRAWLER_H__
#define __LIBTRACKERMINER_CRAWLER_H__

#include <glib-object.h>
#include <gio/gio.h>

G_BEGIN_DECLS

#define TRACKER_TYPE_CRAWLER            (tracker_crawler_get_type ())
#define TRACKER_CRAWLER(object)                 (G_TYPE_CHECK_INSTANCE_CAST ((object), TRACKER_TYPE_CRAWLER, TrackerCrawler))
#define TRACKER_CRAWLER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), TRACKER_TYPE_CRAWLER, TrackerCrawlerClass))
#define TRACKER_IS_CRAWLER(object)      (G_TYPE_CHECK_INSTANCE_TYPE ((object), TRACKER_TYPE_CRAWLER))
#define TRACKER_IS_CRAWLER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), TRACKER_TYPE_CRAWLER))
#define TRACKER_CRAWLER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), TRACKER_TYPE_CRAWLER, TrackerCrawlerClass))

/* Max timeouts time (in msec) */
#define MAX_TIMEOUT_INTERVAL 1000

typedef struct TrackerCrawler         TrackerCrawler;
typedef struct TrackerCrawlerClass    TrackerCrawlerClass;
typedef struct TrackerCrawlerPrivate  TrackerCrawlerPrivate;

struct TrackerCrawler {
	GObject parent;
	TrackerCrawlerPrivate *private;
};

struct TrackerCrawlerClass {
	GObjectClass parent;

	gboolean (* check_directory)     (TrackerCrawler *crawler,
	                                  GFile          *file);
	gboolean (* check_file)          (TrackerCrawler *crawler,
	                                  GFile          *file);
	gboolean (* check_directory_contents) (TrackerCrawler *crawler,
	                                       GFile          *file,
	                                       GList          *contents);
	void     (* finished)            (TrackerCrawler *crawler,
	                                  GQueue         *found_files,
	                                  gboolean        interrupted,
	                                  guint           directories_found,
	                                  guint           directories_ignored,
	                                  guint           files_found,
	                                  guint           files_ignored);
};

GType           tracker_crawler_get_type (void);
TrackerCrawler *tracker_crawler_new      (void);
gboolean        tracker_crawler_start    (TrackerCrawler *crawler,
                                          GFile          *file,
                                          gboolean        recurse);
void            tracker_crawler_stop     (TrackerCrawler *crawler);
void            tracker_crawler_pause    (TrackerCrawler *crawler);
void            tracker_crawler_resume   (TrackerCrawler *crawler);

void            tracker_crawler_set_throttle (TrackerCrawler *crawler,
                                              gdouble         throttle);

G_END_DECLS

#endif /* __LIBTRACKERMINER_CRAWLER_H__ */