/usr/share/gtk-doc/html/camel/camel-CamelDataCache.html is in evolution-data-server-doc 3.28.1-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelDataCache: Camel Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Storage.html" title="Metadata Storage">
<link rel="prev" href="camel-CamelCertDB.html" title="CamelCertDB">
<link rel="next" href="camel-CamelDB.html" title="CamelDB">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#camel-CamelDataCache.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="Storage.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="camel-CamelCertDB.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="camel-CamelDB.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="camel-CamelDataCache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-CamelDataCache.top_of_page"></a>CamelDataCache</span></h2>
<p>CamelDataCache</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="camel-CamelDataCache.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="camel-CamelDataCache.html#CamelDataCacheRemoveFunc" title="CamelDataCacheRemoveFunc ()">*CamelDataCacheRemoveFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">CamelDataCache</span> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelDataCache.html#camel-data-cache-new" title="camel_data_cache_new ()">camel_data_cache_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelDataCache.html#camel-data-cache-get-path" title="camel_data_cache_get_path ()">camel_data_cache_get_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelDataCache.html#camel-data-cache-set-path" title="camel_data_cache_set_path ()">camel_data_cache_set_path</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="camel-CamelDataCache.html#camel-data-cache-get-expire-enabled" title="camel_data_cache_get_expire_enabled ()">camel_data_cache_get_expire_enabled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelDataCache.html#camel-data-cache-set-expire-enabled" title="camel_data_cache_set_expire_enabled ()">camel_data_cache_set_expire_enabled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<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> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../gio/GIOStream.html#GIOStream-struct"><span class="returnvalue">GIOStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelDataCache.html#camel-data-cache-add" title="camel_data_cache_add ()">camel_data_cache_add</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../gio/GIOStream.html#GIOStream-struct"><span class="returnvalue">GIOStream</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelDataCache.html#camel-data-cache-get" title="camel_data_cache_get ()">camel_data_cache_get</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="camel-CamelDataCache.html#camel-data-cache-remove" title="camel_data_cache_remove ()">camel_data_cache_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-CamelDataCache.html#camel-data-cache-get-filename" title="camel_data_cache_get_filename ()">camel_data_cache_get_filename</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelDataCache.html#camel-data-cache-clear" title="camel_data_cache_clear ()">camel_data_cache_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="camel-CamelDataCache.html#camel-data-cache-foreach-remove" title="camel_data_cache_foreach_remove ()">camel_data_cache_foreach_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="camel-CamelDataCache.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="camel-CamelDataCache.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="CamelDataCacheRemoveFunc"></a><h3>CamelDataCacheRemoveFunc ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
<span class="c_punctuation">(</span>*CamelDataCacheRemoveFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">CamelDataCache</span> *cdc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>A callback called for each found file in the cache, used
by <a class="link" href="camel-CamelDataCache.html#camel-data-cache-foreach-remove" title="camel_data_cache_foreach_remove ()"><code class="function">camel_data_cache_foreach_remove()</code></a>. The <em class="parameter"><code>filename</code></em>
corresponds
to the result of <a class="link" href="camel-CamelDataCache.html#camel-data-cache-get-filename" title="camel_data_cache_get_filename ()"><code class="function">camel_data_cache_get_filename()</code></a>.</p>
<div class="refsect3">
<a name="CamelDataCacheRemoveFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cdc</p></td>
<td class="parameter_description"><p>a <span class="type">CamelDataCache</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>a file name found in the cache</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data passed to <a class="link" href="camel-CamelDataCache.html#camel-data-cache-foreach-remove" title="camel_data_cache_foreach_remove ()"><code class="function">camel_data_cache_foreach_remove()</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="CamelDataCacheRemoveFunc.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, to delete the file, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to keep in in the cache</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-26.html#api-index-3.26">3.26</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-data-cache-new"></a><h3>camel_data_cache_new ()</h3>
<pre class="programlisting"><span class="returnvalue">CamelDataCache</span> *
camel_data_cache_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Create a new data cache.</p>
<div class="refsect3">
<a name="camel-data-cache-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>Base path of cache, subdirectories will be created here.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-data-cache-new.returns"></a><h4>Returns</h4>
<p> A new cache object, or NULL if the base path cannot
be written to.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-data-cache-get-path"></a><h3>camel_data_cache_get_path ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
camel_data_cache_get_path (<em class="parameter"><code><span class="type">CamelDataCache</span> *cdc</code></em>);</pre>
<p>Returns the path to the data cache.</p>
<div class="refsect3">
<a name="camel-data-cache-get-path.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cdc</p></td>
<td class="parameter_description"><p>a <span class="type">CamelDataCache</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-data-cache-get-path.returns"></a><h4>Returns</h4>
<p> the path to the data cache</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-32.html#api-index-2.32">2.32</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-data-cache-set-path"></a><h3>camel_data_cache_set_path ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_data_cache_set_path (<em class="parameter"><code><span class="type">CamelDataCache</span> *cdc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);</pre>
<p>Sets the path to the data cache.</p>
<div class="refsect3">
<a name="camel-data-cache-set-path.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cdc</p></td>
<td class="parameter_description"><p>a <span class="type">CamelDataCache</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>path to the data cache</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-32.html#api-index-2.32">2.32</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-data-cache-get-expire-enabled"></a><h3>camel_data_cache_get_expire_enabled ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
camel_data_cache_get_expire_enabled (<em class="parameter"><code><span class="type">CamelDataCache</span> *cdc</code></em>);</pre>
<p>Gets whether expire of cache data is enabled.</p>
<p>This is a complementary property for <a class="link" href="camel-CamelDataCache.html#camel-data-cache-set-expire-age" title="camel_data_cache_set_expire_age ()"><code class="function">camel_data_cache_set_expire_age()</code></a>
and <a class="link" href="camel-CamelDataCache.html#camel-data-cache-set-expire-access" title="camel_data_cache_set_expire_access ()"><code class="function">camel_data_cache_set_expire_access()</code></a>, which allows to disable expiry
without touching the two values. Having expire enabled, but not have set
any of the two times, still behaves like not having expiry enabled.</p>
<div class="refsect3">
<a name="camel-data-cache-get-expire-enabled.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>cdc</p></td>
<td class="parameter_description"><p>a <span class="type">CamelDataCache</span></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-data-cache-get-expire-enabled.returns"></a><h4>Returns</h4>
<p> Whether expire is enabled.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-data-cache-set-expire-enabled"></a><h3>camel_data_cache_set_expire_enabled ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_data_cache_set_expire_enabled (<em class="parameter"><code><span class="type">CamelDataCache</span> *cdc</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> expire_enabled</code></em>);</pre>
<p>Sets whether expire of cache data is enabled.</p>
<p>This is a complementary property for <a class="link" href="camel-CamelDataCache.html#camel-data-cache-set-expire-age" title="camel_data_cache_set_expire_age ()"><code class="function">camel_data_cache_set_expire_age()</code></a>
and <a class="link" href="camel-CamelDataCache.html#camel-data-cache-set-expire-access" title="camel_data_cache_set_expire_access ()"><code class="function">camel_data_cache_set_expire_access()</code></a>, which allows to disable expiry
without touching the two values. Having expire enabled, but not have set
any of the two times, still behaves like not having expiry enabled.</p>
<div class="refsect3">
<a name="camel-data-cache-set-expire-enabled.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cdc</p></td>
<td class="parameter_description"><p>a <span class="type">CamelDataCache</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>expire_enabled</p></td>
<td class="parameter_description"><p>a value to set</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-24.html#api-index-3.24">3.24</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-data-cache-set-expire-age"></a><h3>camel_data_cache_set_expire_age ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_data_cache_set_expire_age (<em class="parameter"><code><span class="type">CamelDataCache</span> *cdc</code></em>,
<em class="parameter"><code><span class="type">time_t</span> when</code></em>);</pre>
<p>Set the cache expiration policy for aged entries.</p>
<p>Items in the cache older than <em class="parameter"><code>when</code></em>
seconds may be
flushed at any time. Items are expired in a lazy
manner, so it is indeterminate when the items will
physically be removed.</p>
<p>Note you can set both an age and an access limit. The
age acts as a hard limit on cache entries.</p>
<div class="refsect3">
<a name="camel-data-cache-set-expire-age.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cdc</p></td>
<td class="parameter_description"><p>A <span class="type">CamelDataCache</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>when</p></td>
<td class="parameter_description"><p>Timeout for age expiry, or -1 to disable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-data-cache-set-expire-access"></a><h3>camel_data_cache_set_expire_access ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_data_cache_set_expire_access (<em class="parameter"><code><span class="type">CamelDataCache</span> *cdc</code></em>,
<em class="parameter"><code><span class="type">time_t</span> when</code></em>);</pre>
<p>Set the cache expiration policy for access times.</p>
<p>Items in the cache which haven't been accessed for <em class="parameter"><code>when</code></em>
seconds may be expired at any time. Items are expired in a lazy
manner, so it is indeterminate when the items will
physically be removed.</p>
<p>Note you can set both an age and an access limit. The
age acts as a hard limit on cache entries.</p>
<div class="refsect3">
<a name="camel-data-cache-set-expire-access.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cdc</p></td>
<td class="parameter_description"><p>A <span class="type">CamelDataCache</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>when</p></td>
<td class="parameter_description"><p>Timeout for access, or -1 to disable access expiry.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-data-cache-add"></a><h3>camel_data_cache_add ()</h3>
<pre class="programlisting"><a href="../gio/GIOStream.html#GIOStream-struct"><span class="returnvalue">GIOStream</span></a> *
camel_data_cache_add (<em class="parameter"><code><span class="type">CamelDataCache</span> *cdc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Add a new item to the cache, returning a <a href="../gio/GIOStream.html#GIOStream-struct"><span class="type">GIOStream</span></a> to the new item.</p>
<p>The key and the path combine to form a unique key used to store the item.</p>
<p>Potentially, expiry processing will be performed while this call is
executing.</p>
<p>The returned <a href="../gio/GIOStream.html#GIOStream-struct"><span class="type">GIOStream</span></a> is referenced for thread-safety and must be
unreferenced with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="camel-data-cache-add.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cdc</p></td>
<td class="parameter_description"><p>A <span class="type">CamelDataCache</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>Relative path of item to add.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>Key of item to add.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-data-cache-add.returns"></a><h4>Returns</h4>
<p>a <a href="../gio/GIOStream.html#GIOStream-struct"><span class="type">GIOStream</span></a> for the new cache item, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-data-cache-get"></a><h3>camel_data_cache_get ()</h3>
<pre class="programlisting"><a href="../gio/GIOStream.html#GIOStream-struct"><span class="returnvalue">GIOStream</span></a> *
camel_data_cache_get (<em class="parameter"><code><span class="type">CamelDataCache</span> *cdc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Lookup an item in the cache. If the item exists, a <a href="../gio/GIOStream.html#GIOStream-struct"><span class="type">GIOStream</span></a> is returned
for the item. The stream may be shared by multiple callers, so ensure the
stream is in a valid state through external locking.</p>
<p>The returned <a href="../gio/GIOStream.html#GIOStream-struct"><span class="type">GIOStream</span></a> is referenced for thread-safety and must be
unreferenced with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="camel-data-cache-get.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cdc</p></td>
<td class="parameter_description"><p>A <span class="type">CamelDataCache</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>Path to the (sub) cache the item exists in.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>Key for the cache item.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-data-cache-get.returns"></a><h4>Returns</h4>
<p>a <a href="../gio/GIOStream.html#GIOStream-struct"><span class="type">GIOStream</span></a> for the requested cache item, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-data-cache-remove"></a><h3>camel_data_cache_remove ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
camel_data_cache_remove (<em class="parameter"><code><span class="type">CamelDataCache</span> *cdc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Remove/expire a cache item.</p>
<div class="refsect3">
<a name="camel-data-cache-remove.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cdc</p></td>
<td class="parameter_description"><p>A <span class="type">CamelDataCache</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>Path to the (sub) cache the item exists in.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>Key for the cache item.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-data-cache-remove.returns"></a><h4>Returns</h4>
<p> 0 on success, -1 on error</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="camel-data-cache-get-filename"></a><h3>camel_data_cache_get_filename ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
camel_data_cache_get_filename (<em class="parameter"><code><span class="type">CamelDataCache</span> *cdc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>Lookup the filename for an item in the cache</p>
<div class="refsect3">
<a name="camel-data-cache-get-filename.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cdc</p></td>
<td class="parameter_description"><p>A <span class="type">CamelDataCache</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>Path to the (sub) cache the item exists in.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>Key for the cache item.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="camel-data-cache-get-filename.returns"></a><h4>Returns</h4>
<p> The filename for a cache item</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2-26.html#api-index-2.26">2.26</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-data-cache-clear"></a><h3>camel_data_cache_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_data_cache_clear (<em class="parameter"><code><span class="type">CamelDataCache</span> *cdc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>);</pre>
<p>Clear cache's content in <em class="parameter"><code>path</code></em>
.</p>
<div class="refsect3">
<a name="camel-data-cache-clear.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cdc</p></td>
<td class="parameter_description"><p>a <span class="type">CamelDataCache</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>Path to the (sub) cache the item exists in.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-2.html#api-index-3.2">3.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="camel-data-cache-foreach-remove"></a><h3>camel_data_cache_foreach_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_data_cache_foreach_remove (<em class="parameter"><code><span class="type">CamelDataCache</span> *cdc</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code><a class="link" href="camel-CamelDataCache.html#CamelDataCacheRemoveFunc" title="CamelDataCacheRemoveFunc ()"><span class="type">CamelDataCacheRemoveFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Traverses the <em class="parameter"><code>cdc</code></em>
sub-cache identified by <em class="parameter"><code>path</code></em>
and calls <em class="parameter"><code>func</code></em>
for each found file.
If the <em class="parameter"><code>func</code></em>
returns <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, then the file is removed, if <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, it's kept in the cache.</p>
<div class="refsect3">
<a name="camel-data-cache-foreach-remove.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>cdc</p></td>
<td class="parameter_description"><p>a <span class="type">CamelDataCache</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>Path to the (sub) cache the items exist in</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>a callback to call for each found file in the cache. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>][<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym> user_data]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data passed to <em class="parameter"><code>func</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3-26.html#api-index-3.26">3.26</a></p>
</div>
</div>
<div class="refsect1">
<a name="camel-CamelDataCache.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|