2010-10-13 Sergio Villar Senin <svillar@igalia.com>
[WebKit-https.git] / WebCore / platform / network / soup / cache / webkit / soup-cache.h
1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
2 /*
3  * soup-cache.h:
4  *
5  * Copyright (C) 2009, 2010 Igalia, S.L.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #ifndef WEBKIT_SOUP_CACHE_H
24 #define WEBKIT_SOUP_CACHE_H 1
25
26 #include <webkit/webkitdefines.h>
27
28 #include <libsoup/soup-types.h>
29 #include <gio/gio.h>
30
31 G_BEGIN_DECLS
32
33 #define WEBKIT_TYPE_SOUP_CACHE            (webkit_soup_cache_get_type ())
34 #define WEBKIT_SOUP_CACHE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), WEBKIT_TYPE_SOUP_CACHE, WebKitSoupCache))
35 #define WEBKIT_SOUP_CACHE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), WEBKIT_TYPE_SOUP_CACHE, WebKitSoupCacheClass))
36 #define WEBKIT_IS_SOUP_CACHE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), WEBKIT_TYPE_SOUP_CACHE))
37 #define WEBKIT_IS_SOUP_CACHE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((obj), WEBKIT_TYPE_SOUP_CACHE))
38 #define WEBKIT_SOUP_CACHE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), WEBKIT_TYPE_SOUP_CACHE, WebKitSoupCacheClass))
39
40 typedef struct _WebKitSoupCache WebKitSoupCache;
41 typedef struct _WebKitSoupCachePrivate WebKitSoupCachePrivate;
42
43 typedef enum {
44         WEBKIT_SOUP_CACHE_CACHEABLE = (1 << 0),
45         WEBKIT_SOUP_CACHE_UNCACHEABLE = (1 << 1),
46         WEBKIT_SOUP_CACHE_INVALIDATES = (1 << 2),
47         WEBKIT_SOUP_CACHE_VALIDATES = (1 << 3)
48 } WebKitSoupCacheability;
49
50 typedef enum {
51         WEBKIT_SOUP_CACHE_RESPONSE_FRESH,
52         WEBKIT_SOUP_CACHE_RESPONSE_NEEDS_VALIDATION,
53         WEBKIT_SOUP_CACHE_RESPONSE_STALE
54 } WebKitSoupCacheResponse;
55
56 typedef enum {
57         WEBKIT_SOUP_CACHE_SINGLE_USER,
58         WEBKIT_SOUP_CACHE_SHARED
59 } WebKitSoupCacheType;
60
61 struct _WebKitSoupCache {
62         GObject parent_instance;
63
64         WebKitSoupCachePrivate *priv;
65 };
66
67 typedef struct {
68         GObjectClass parent_class;
69
70         /* methods */
71         WebKitSoupCacheability (*get_cacheability)(WebKitSoupCache *cache, SoupMessage *msg);
72
73         /* Padding for future expansion */
74         void (*_libsoup_reserved1)(void);
75         void (*_libsoup_reserved2)(void);
76         void (*_libsoup_reserved3)(void);
77 } WebKitSoupCacheClass;
78
79 WEBKIT_API GType             webkit_soup_cache_get_type (void);
80 WEBKIT_API WebKitSoupCache  *webkit_soup_cache_new (const char  *cache_dir,
81                                                     WebKitSoupCacheType cache_type);
82 WEBKIT_API void              webkit_soup_cache_flush (WebKitSoupCache   *cache);
83 WEBKIT_API void              webkit_soup_cache_clear (WebKitSoupCache   *cache);
84
85 WEBKIT_API void              webkit_soup_cache_dump (WebKitSoupCache *cache);
86 WEBKIT_API void              webkit_soup_cache_load (WebKitSoupCache *cache);
87
88 WEBKIT_API void              webkit_soup_cache_set_max_size (WebKitSoupCache *cache,
89                                                              guint max_size);
90 WEBKIT_API guint             webkit_soup_cache_get_max_size (WebKitSoupCache *cache);
91
92 G_END_DECLS
93
94
95 #endif /* WEBKIT_SOUP_CACHE_H */
96