← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + 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/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/html/camel-CamelDataCache.html
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.0">
 
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">
26
26
                  <a href="#camel-CamelDataCache.description" class="shortcut">Description</a>
27
27
</td></tr>
28
28
</table>
29
 
<div class="refentry" lang="en">
 
29
<div class="refentry" title="CamelDataCache">
30
30
<a name="camel-CamelDataCache"></a><div class="titlepage"></div>
31
31
<div class="refnamediv"><table width="100%"><tr>
32
32
<td valign="top">
35
35
</td>
36
36
<td valign="top" align="right"></td>
37
37
</tr></table></div>
38
 
<div class="refsynopsisdiv">
 
38
<div class="refsynopsisdiv" title="Synopsis">
39
39
<a name="camel-CamelDataCache.synopsis"></a><h2>Synopsis</h2>
40
40
<pre class="synopsis">                    <a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache">CamelDataCache</a>;
41
41
<a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache"><span class="returnvalue">CamelDataCache</span></a> *    <a class="link" href="camel-CamelDataCache.html#camel-data-cache-new" title="camel_data_cache_new ()">camel_data_cache_new</a>                (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
70
70
                                                         <em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);
71
71
</pre>
72
72
</div>
73
 
<div class="refsect1" lang="en">
 
73
<div class="refsect1" title="Description">
74
74
<a name="camel-CamelDataCache.description"></a><h2>Description</h2>
75
75
<p>
76
76
</p>
77
77
</div>
78
 
<div class="refsect1" lang="en">
 
78
<div class="refsect1" title="Details">
79
79
<a name="camel-CamelDataCache.details"></a><h2>Details</h2>
80
 
<div class="refsect2" lang="en">
 
80
<div class="refsect2" title="CamelDataCache">
81
81
<a name="CamelDataCache"></a><h3>CamelDataCache</h3>
82
82
<pre class="programlisting">typedef struct {
83
83
        CamelObject parent_object;
95
95
</p>
96
96
</div>
97
97
<hr>
98
 
<div class="refsect2" lang="en">
 
98
<div class="refsect2" title="camel_data_cache_new ()">
99
99
<a name="camel-data-cache-new"></a><h3>camel_data_cache_new ()</h3>
100
100
<pre class="programlisting"><a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache"><span class="returnvalue">CamelDataCache</span></a> *    camel_data_cache_new                (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
101
101
                                                         <em class="parameter"><code><span class="type">guint32</span> flags</code></em>,
102
102
                                                         <em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
103
103
<p>
104
 
Create a new data cache.</p>
 
104
Create a new data cache.
 
105
</p>
105
106
<div class="variablelist"><table border="0">
106
107
<col align="left" valign="top">
107
108
<tbody>
125
126
</table></div>
126
127
</div>
127
128
<hr>
128
 
<div class="refsect2" lang="en">
 
129
<div class="refsect2" title="camel_data_cache_set_expire_age ()">
129
130
<a name="camel-data-cache-set-expire-age"></a><h3>camel_data_cache_set_expire_age ()</h3>
130
131
<pre class="programlisting"><span class="returnvalue">void</span>                camel_data_cache_set_expire_age     (<em class="parameter"><code><a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache"><span class="type">CamelDataCache</span></a> *cdc</code></em>,
131
132
                                                         <em class="parameter"><code><span class="type">time_t</span> when</code></em>);</pre>
140
141
</p>
141
142
<p>
142
143
Note you can set both an age and an access limit.  The
143
 
age acts as a hard limit on cache entries.</p>
 
144
age acts as a hard limit on cache entries.
 
145
</p>
144
146
<div class="variablelist"><table border="0">
145
147
<col align="left" valign="top">
146
148
<tbody>
158
160
</table></div>
159
161
</div>
160
162
<hr>
161
 
<div class="refsect2" lang="en">
 
163
<div class="refsect2" title="camel_data_cache_set_expire_access ()">
162
164
<a name="camel-data-cache-set-expire-access"></a><h3>camel_data_cache_set_expire_access ()</h3>
163
165
<pre class="programlisting"><span class="returnvalue">void</span>                camel_data_cache_set_expire_access  (<em class="parameter"><code><a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache"><span class="type">CamelDataCache</span></a> *cdc</code></em>,
164
166
                                                         <em class="parameter"><code><span class="type">time_t</span> when</code></em>);</pre>
173
175
</p>
174
176
<p>
175
177
Note you can set both an age and an access limit.  The
176
 
age acts as a hard limit on cache entries.</p>
 
178
age acts as a hard limit on cache entries.
 
179
</p>
177
180
<div class="variablelist"><table border="0">
178
181
<col align="left" valign="top">
179
182
<tbody>
191
194
</table></div>
192
195
</div>
193
196
<hr>
194
 
<div class="refsect2" lang="en">
 
197
<div class="refsect2" title="camel_data_cache_rename ()">
195
198
<a name="camel-data-cache-rename"></a><h3>camel_data_cache_rename ()</h3>
196
199
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_data_cache_rename             (<em class="parameter"><code><a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache"><span class="type">CamelDataCache</span></a> *cache</code></em>,
197
200
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *old</code></em>,
202
205
are accessible using the new path.
203
206
</p>
204
207
<p>
205
 
CURRENTLY UNIMPLEMENTED</p>
 
208
CURRENTLY UNIMPLEMENTED
 
209
</p>
206
210
<div class="variablelist"><table border="0">
207
211
<col align="left" valign="top">
208
212
<tbody><tr>
213
217
</table></div>
214
218
</div>
215
219
<hr>
216
 
<div class="refsect2" lang="en">
 
220
<div class="refsect2" title="camel_data_cache_add ()">
217
221
<a name="camel-data-cache-add"></a><h3>camel_data_cache_add ()</h3>
218
222
<pre class="programlisting"><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="returnvalue">CamelStream</span></a> *       camel_data_cache_add                (<em class="parameter"><code><a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache"><span class="type">CamelDataCache</span></a> *cdc</code></em>,
219
223
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
228
232
</p>
229
233
<p>
230
234
Potentially, expiry processing will be performed while this call
231
 
is executing.</p>
 
235
is executing.
 
236
</p>
232
237
<div class="variablelist"><table border="0">
233
238
<col align="left" valign="top">
234
239
<tbody>
257
262
</table></div>
258
263
</div>
259
264
<hr>
260
 
<div class="refsect2" lang="en">
 
265
<div class="refsect2" title="camel_data_cache_get ()">
261
266
<a name="camel-data-cache-get"></a><h3>camel_data_cache_get ()</h3>
262
267
<pre class="programlisting"><a class="link" href="camel-CamelStream.html#CamelStream" title="struct CamelStream"><span class="returnvalue">CamelStream</span></a> *       camel_data_cache_get                (<em class="parameter"><code><a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache"><span class="type">CamelDataCache</span></a> *cdc</code></em>,
263
268
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
267
272
Lookup an item in the cache.  If the item exists, a stream
268
273
is returned for the item.  The stream may be shared by
269
274
multiple callers, so ensure the stream is in a valid state
270
 
through external locking.</p>
 
275
through external locking.
 
276
</p>
271
277
<div class="variablelist"><table border="0">
272
278
<col align="left" valign="top">
273
279
<tbody>
295
301
</table></div>
296
302
</div>
297
303
<hr>
298
 
<div class="refsect2" lang="en">
 
304
<div class="refsect2" title="camel_data_cache_remove ()">
299
305
<a name="camel-data-cache-remove"></a><h3>camel_data_cache_remove ()</h3>
300
306
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_data_cache_remove             (<em class="parameter"><code><a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache"><span class="type">CamelDataCache</span></a> *cdc</code></em>,
301
307
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
302
308
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
303
309
                                                         <em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
304
310
<p>
305
 
Remove/expire a cache item.</p>
 
311
Remove/expire a cache item.
 
312
</p>
306
313
<div class="variablelist"><table border="0">
307
314
<col align="left" valign="top">
308
315
<tbody>
320
327
</table></div>
321
328
</div>
322
329
<hr>
323
 
<div class="refsect2" lang="en">
 
330
<div class="refsect2" title="camel_data_cache_clear ()">
324
331
<a name="camel-data-cache-clear"></a><h3>camel_data_cache_clear ()</h3>
325
332
<pre class="programlisting"><span class="returnvalue">gint</span>                camel_data_cache_clear              (<em class="parameter"><code><a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache"><span class="type">CamelDataCache</span></a> *cache</code></em>,
326
333
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
329
336
Clear all items in a given cache path or all items in the cache.
330
337
</p>
331
338
<p>
332
 
CURRENTLY_UNIMPLEMENTED</p>
 
339
CURRENTLY_UNIMPLEMENTED
 
340
</p>
333
341
<div class="variablelist"><table border="0">
334
342
<col align="left" valign="top">
335
343
<tbody>
347
355
</table></div>
348
356
</div>
349
357
<hr>
350
 
<div class="refsect2" lang="en">
 
358
<div class="refsect2" title="camel_data_cache_get_filename ()">
351
359
<a name="camel-data-cache-get-filename"></a><h3>camel_data_cache_get_filename ()</h3>
352
360
<pre class="programlisting"><span class="returnvalue">gchar</span> *             camel_data_cache_get_filename       (<em class="parameter"><code><a class="link" href="camel-CamelDataCache.html#CamelDataCache" title="CamelDataCache"><span class="type">CamelDataCache</span></a> *cdc</code></em>,
353
361
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
354
362
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
355
363
                                                         <em class="parameter"><code><a class="link" href="camel-camel-exception.html#CamelException" title="struct CamelException"><span class="type">CamelException</span></a> *ex</code></em>);</pre>
356
364
<p>
357
 
Lookup the filename for an item in the cache</p>
 
365
Lookup the filename for an item in the cache
 
366
</p>
358
367
<div class="variablelist"><table border="0">
359
368
<col align="left" valign="top">
360
369
<tbody>
376
385
<tr>
377
386
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
378
387
<td> The filename for a cache item
 
388
 
379
389
</td>
380
390
</tr>
381
391
</tbody>
382
392
</table></div>
 
393
<p class="since">Since 2.26</p>
383
394
</div>
384
395
</div>
385
396
</div>