~ubuntu-branches/ubuntu/lucid/evolution-data-server/lucid-security

« back to all changes in this revision

Viewing changes to docs/reference/camel/html/camel-CamelDataCache.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2009-12-16 22:11:22 UTC
  • mfrom: (1.1.76 upstream) (1.2.8 squeeze)
  • Revision ID: james.westby@ubuntu.com-20091216221122-mjwmo4lk4co6sxkb
Tags: 2.28.2-1ubuntu1
* Resync on Debian
* New upstream version:
  - #602719 - Crash in ep_set_proxy with no proxy user or password
    (lp: #481457)
* debian/control:
  - don't use libgnome
  - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
* debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
  debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
  - install html documentation
* debian/evolution-data-server.install,
  debian/patches/45_libcamel_providers_version.patch:
  - use the upstream versioning, not a Debian-specific one  
* debian/rules:
  - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>CamelDataCache</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.3">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="Storage.html" title="Metadata Storage">
9
9
<link rel="prev" href="camel-CamelCertDB.html" title="CamelCertDB">
43
43
                <a href="#camel-CamelDataCache.description" class="shortcut">Description</a>
44
44
</td></tr>
45
45
</table>
46
 
<div class="refentry" lang="en">
 
46
<div class="refentry" title="CamelDataCache">
47
47
<a name="camel-CamelDataCache"></a><div class="titlepage"></div>
48
48
<div class="refnamediv"><table width="100%"><tr>
49
49
<td valign="top">
52
52
</td>
53
53
<td valign="top" align="right"></td>
54
54
</tr></table></div>
55
 
<div class="refsynopsisdiv">
 
55
<div class="refsynopsisdiv" title="Synopsis">
56
56
<a name="camel-CamelDataCache.synopsis"></a><h2>Synopsis</h2>
57
57
<pre class="synopsis">
58
58
                    <a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a>;
59
 
<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *    <a class="link" href="camel-CamelDataCache.html#camel-data-cache-new" title="camel_data_cache_new ()">camel_data_cache_new</a>                (const gchar *path,
60
 
                                                         guint32 flags,
 
59
<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *    <a class="link" href="camel-CamelDataCache.html#camel-data-cache-new" title="camel_data_cache_new ()">camel_data_cache_new</a>                (const <a
 
60
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
61
>gchar</a> *path,
 
62
                                                         <a
 
63
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
 
64
>guint32</a> flags,
61
65
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);
62
66
void                <a class="link" href="camel-CamelDataCache.html#camel-data-cache-set-expire-age" title="camel_data_cache_set_expire_age ()">camel_data_cache_set_expire_age</a>     (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
63
67
                                                         time_t when);
64
68
void                <a class="link" href="camel-CamelDataCache.html#camel-data-cache-set-expire-access" title="camel_data_cache_set_expire_access ()">camel_data_cache_set_expire_access</a>  (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
65
69
                                                         time_t when);
66
 
gint                <a class="link" href="camel-CamelDataCache.html#camel-data-cache-rename" title="camel_data_cache_rename ()">camel_data_cache_rename</a>             (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cache,
67
 
                                                         const gchar *old,
68
 
                                                         const gchar *new,
 
70
<a
 
71
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
72
>gint</a>                <a class="link" href="camel-CamelDataCache.html#camel-data-cache-rename" title="camel_data_cache_rename ()">camel_data_cache_rename</a>             (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cache,
 
73
                                                         const <a
 
74
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
75
>gchar</a> *old,
 
76
                                                         const <a
 
77
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
78
>gchar</a> *new,
69
79
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);
70
80
<a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream">CamelStream</a> *       <a class="link" href="camel-CamelDataCache.html#camel-data-cache-add" title="camel_data_cache_add ()">camel_data_cache_add</a>                (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
71
 
                                                         const gchar *path,
72
 
                                                         const gchar *key,
 
81
                                                         const <a
 
82
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
83
>gchar</a> *path,
 
84
                                                         const <a
 
85
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
86
>gchar</a> *key,
73
87
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);
74
88
<a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream">CamelStream</a> *       <a class="link" href="camel-CamelDataCache.html#camel-data-cache-get" title="camel_data_cache_get ()">camel_data_cache_get</a>                (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
75
 
                                                         const gchar *path,
76
 
                                                         const gchar *key,
77
 
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);
78
 
gint                <a class="link" href="camel-CamelDataCache.html#camel-data-cache-remove" title="camel_data_cache_remove ()">camel_data_cache_remove</a>             (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
79
 
                                                         const gchar *path,
80
 
                                                         const gchar *key,
81
 
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);
82
 
gint                <a class="link" href="camel-CamelDataCache.html#camel-data-cache-clear" title="camel_data_cache_clear ()">camel_data_cache_clear</a>              (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cache,
83
 
                                                         const gchar *path,
84
 
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);
85
 
gchar *             <a class="link" href="camel-CamelDataCache.html#camel-data-cache-get-filename" title="camel_data_cache_get_filename ()">camel_data_cache_get_filename</a>       (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
86
 
                                                         const gchar *path,
87
 
                                                         const gchar *key,
 
89
                                                         const <a
 
90
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
91
>gchar</a> *path,
 
92
                                                         const <a
 
93
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
94
>gchar</a> *key,
 
95
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);
 
96
<a
 
97
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
98
>gint</a>                <a class="link" href="camel-CamelDataCache.html#camel-data-cache-remove" title="camel_data_cache_remove ()">camel_data_cache_remove</a>             (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
 
99
                                                         const <a
 
100
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
101
>gchar</a> *path,
 
102
                                                         const <a
 
103
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
104
>gchar</a> *key,
 
105
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);
 
106
<a
 
107
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
108
>gint</a>                <a class="link" href="camel-CamelDataCache.html#camel-data-cache-clear" title="camel_data_cache_clear ()">camel_data_cache_clear</a>              (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cache,
 
109
                                                         const <a
 
110
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
111
>gchar</a> *path,
 
112
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);
 
113
<a
 
114
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
115
>gchar</a> *             <a class="link" href="camel-CamelDataCache.html#camel-data-cache-get-filename" title="camel_data_cache_get_filename ()">camel_data_cache_get_filename</a>       (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
 
116
                                                         const <a
 
117
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
118
>gchar</a> *path,
 
119
                                                         const <a
 
120
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
121
>gchar</a> *key,
88
122
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);
89
123
</pre>
90
124
</div>
91
 
<div class="refsect1" lang="en">
 
125
<div class="refsect1" title="Description">
92
126
<a name="camel-CamelDataCache.description"></a><h2>Description</h2>
93
127
<p>
94
128
</p>
95
129
</div>
96
 
<div class="refsect1" lang="en">
 
130
<div class="refsect1" title="Details">
97
131
<a name="camel-CamelDataCache.details"></a><h2>Details</h2>
98
 
<div class="refsect2" lang="en">
 
132
<div class="refsect2" title="CamelDataCache">
99
133
<a name="CamelDataCache"></a><h3>CamelDataCache</h3>
100
134
<pre class="programlisting">typedef struct {
101
135
        CamelObject parent_object;
113
147
</p>
114
148
</div>
115
149
<hr>
116
 
<div class="refsect2" lang="en">
 
150
<div class="refsect2" title="camel_data_cache_new ()">
117
151
<a name="camel-data-cache-new"></a><h3>camel_data_cache_new ()</h3>
118
 
<pre class="programlisting"><a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *    camel_data_cache_new                (const gchar *path,
119
 
                                                         guint32 flags,
 
152
<pre class="programlisting"><a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *    camel_data_cache_new                (const <a
 
153
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
154
>gchar</a> *path,
 
155
                                                         <a
 
156
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"
 
157
>guint32</a> flags,
120
158
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);</pre>
121
159
<p>
122
160
Create a new data cache.</p>
150
188
</table></div>
151
189
</div>
152
190
<hr>
153
 
<div class="refsect2" lang="en">
 
191
<div class="refsect2" title="camel_data_cache_set_expire_age ()">
154
192
<a name="camel-data-cache-set-expire-age"></a><h3>camel_data_cache_set_expire_age ()</h3>
155
193
<pre class="programlisting">void                camel_data_cache_set_expire_age     (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
156
194
                                                         time_t when);</pre>
185
223
</table></div>
186
224
</div>
187
225
<hr>
188
 
<div class="refsect2" lang="en">
 
226
<div class="refsect2" title="camel_data_cache_set_expire_access ()">
189
227
<a name="camel-data-cache-set-expire-access"></a><h3>camel_data_cache_set_expire_access ()</h3>
190
228
<pre class="programlisting">void                camel_data_cache_set_expire_access  (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
191
229
                                                         time_t when);</pre>
220
258
</table></div>
221
259
</div>
222
260
<hr>
223
 
<div class="refsect2" lang="en">
 
261
<div class="refsect2" title="camel_data_cache_rename ()">
224
262
<a name="camel-data-cache-rename"></a><h3>camel_data_cache_rename ()</h3>
225
 
<pre class="programlisting">gint                camel_data_cache_rename             (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cache,
226
 
                                                         const gchar *old,
227
 
                                                         const gchar *new,
 
263
<pre class="programlisting"><a
 
264
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
265
>gint</a>                camel_data_cache_rename             (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cache,
 
266
                                                         const <a
 
267
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
268
>gchar</a> *old,
 
269
                                                         const <a
 
270
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
271
>gchar</a> *new,
228
272
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);</pre>
229
273
<p>
230
274
Rename a cache path.  All cache items accessed from the old path
266
310
</table></div>
267
311
</div>
268
312
<hr>
269
 
<div class="refsect2" lang="en">
 
313
<div class="refsect2" title="camel_data_cache_add ()">
270
314
<a name="camel-data-cache-add"></a><h3>camel_data_cache_add ()</h3>
271
315
<pre class="programlisting"><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream">CamelStream</a> *       camel_data_cache_add                (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
272
 
                                                         const gchar *path,
273
 
                                                         const gchar *key,
 
316
                                                         const <a
 
317
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
318
>gchar</a> *path,
 
319
                                                         const <a
 
320
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
321
>gchar</a> *key,
274
322
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);</pre>
275
323
<p>
276
324
Add a new item to the cache.
317
365
</table></div>
318
366
</div>
319
367
<hr>
320
 
<div class="refsect2" lang="en">
 
368
<div class="refsect2" title="camel_data_cache_get ()">
321
369
<a name="camel-data-cache-get"></a><h3>camel_data_cache_get ()</h3>
322
370
<pre class="programlisting"><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream">CamelStream</a> *       camel_data_cache_get                (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
323
 
                                                         const gchar *path,
324
 
                                                         const gchar *key,
 
371
                                                         const <a
 
372
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
373
>gchar</a> *path,
 
374
                                                         const <a
 
375
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
376
>gchar</a> *key,
325
377
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);</pre>
326
378
<p>
327
379
Lookup an item in the cache.  If the item exists, a stream
362
414
</table></div>
363
415
</div>
364
416
<hr>
365
 
<div class="refsect2" lang="en">
 
417
<div class="refsect2" title="camel_data_cache_remove ()">
366
418
<a name="camel-data-cache-remove"></a><h3>camel_data_cache_remove ()</h3>
367
 
<pre class="programlisting">gint                camel_data_cache_remove             (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
368
 
                                                         const gchar *path,
369
 
                                                         const gchar *key,
 
419
<pre class="programlisting"><a
 
420
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
421
>gint</a>                camel_data_cache_remove             (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
 
422
                                                         const <a
 
423
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
424
>gchar</a> *path,
 
425
                                                         const <a
 
426
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
427
>gchar</a> *key,
370
428
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);</pre>
371
429
<p>
372
430
Remove/expire a cache item.</p>
404
462
</table></div>
405
463
</div>
406
464
<hr>
407
 
<div class="refsect2" lang="en">
 
465
<div class="refsect2" title="camel_data_cache_clear ()">
408
466
<a name="camel-data-cache-clear"></a><h3>camel_data_cache_clear ()</h3>
409
 
<pre class="programlisting">gint                camel_data_cache_clear              (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cache,
410
 
                                                         const gchar *path,
 
467
<pre class="programlisting"><a
 
468
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
 
469
>gint</a>                camel_data_cache_clear              (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cache,
 
470
                                                         const <a
 
471
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
472
>gchar</a> *path,
411
473
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);</pre>
412
474
<p>
413
475
Clear all items in a given cache path or all items in the cache.
443
505
</table></div>
444
506
</div>
445
507
<hr>
446
 
<div class="refsect2" lang="en">
 
508
<div class="refsect2" title="camel_data_cache_get_filename ()">
447
509
<a name="camel-data-cache-get-filename"></a><h3>camel_data_cache_get_filename ()</h3>
448
 
<pre class="programlisting">gchar *             camel_data_cache_get_filename       (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
449
 
                                                         const gchar *path,
450
 
                                                         const gchar *key,
 
510
<pre class="programlisting"><a
 
511
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
512
>gchar</a> *             camel_data_cache_get_filename       (<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a> *cdc,
 
513
                                                         const <a
 
514
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
515
>gchar</a> *path,
 
516
                                                         const <a
 
517
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
 
518
>gchar</a> *key,
451
519
                                                         <a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException">CamelException</a> *ex);</pre>
452
520
<p>
453
521
Lookup the filename for an item in the cache</p>