/usr/share/gtk-doc/html/camel/CamelObject.html is in libcamel1.2-dev 3.2.3-0ubuntu7.1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelObject</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Fundamentals.html" title="Fundamentals">
<link rel="prev" href="camel-camel-debug.html" title="camel-debug">
<link rel="next" href="camel-camel-operation.html" title="camel-operation">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="camel-camel-debug.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Fundamentals.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="camel-camel-operation.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelObject.synopsis" class="shortcut">Top</a>
|
<a href="#CamelObject.description" class="shortcut">Description</a>
|
<a href="#CamelObject.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelObject"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelObject.top_of_page"></a>CamelObject</span></h2>
<p>CamelObject</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelObject.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="CamelObject.html#CamelObject-struct" title="struct CamelObject">CamelObject</a>;
#define <a class="link" href="CamelObject.html#CAMEL-ERROR:CAPS" title="CAMEL_ERROR">CAMEL_ERROR</a>
enum <a class="link" href="CamelObject.html#CamelError" title="enum CamelError">CamelError</a>;
enum <a class="link" href="CamelObject.html#CamelParamFlags" title="enum CamelParamFlags">CamelParamFlags</a>;
<span class="returnvalue">gint</span> <a class="link" href="CamelObject.html#camel-object-state-read" title="camel_object_state_read ()">camel_object_state_read</a> (<em class="parameter"><code><a class="link" href="CamelObject.html" title="CamelObject"><span class="type">CamelObject</span></a> *object</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelObject.html#camel-object-state-write" title="camel_object_state_write ()">camel_object_state_write</a> (<em class="parameter"><code><a class="link" href="CamelObject.html" title="CamelObject"><span class="type">CamelObject</span></a> *object</code></em>);
const <span class="returnvalue">gchar</span> * <a class="link" href="CamelObject.html#camel-object-get-state-filename" title="camel_object_get_state_filename ()">camel_object_get_state_filename</a> (<em class="parameter"><code><a class="link" href="CamelObject.html" title="CamelObject"><span class="type">CamelObject</span></a> *object</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelObject.html#camel-object-set-state-filename" title="camel_object_set_state_filename ()">camel_object_set_state_filename</a> (<em class="parameter"><code><a class="link" href="CamelObject.html" title="CamelObject"><span class="type">CamelObject</span></a> *object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *state_filename</code></em>);
<a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag">CamelObjectBag</a>;
<span class="returnvalue">gpointer</span> (<a class="link" href="CamelObject.html#CamelCopyFunc" title="CamelCopyFunc ()">*CamelCopyFunc</a>) (<em class="parameter"><code><span class="type">gconstpointer</span> object</code></em>);
<a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="returnvalue">CamelObjectBag</span></a> * <a class="link" href="CamelObject.html#camel-object-bag-new" title="camel_object_bag_new ()">camel_object_bag_new</a> (<em class="parameter"><code><span class="type">GHashFunc</span> key_hash_func</code></em>,
<em class="parameter"><code><span class="type">GEqualFunc</span> key_equal_func</code></em>,
<em class="parameter"><code><a class="link" href="CamelObject.html#CamelCopyFunc" title="CamelCopyFunc ()"><span class="type">CamelCopyFunc</span></a> key_copy_func</code></em>,
<em class="parameter"><code><span class="type">GFreeFunc</span> key_free_func</code></em>);
<span class="returnvalue">gpointer</span> <a class="link" href="CamelObject.html#camel-object-bag-get" title="camel_object_bag_get ()">camel_object_bag_get</a> (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> key</code></em>);
<span class="returnvalue">gpointer</span> <a class="link" href="CamelObject.html#camel-object-bag-peek" title="camel_object_bag_peek ()">camel_object_bag_peek</a> (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> key</code></em>);
<span class="returnvalue">gpointer</span> <a class="link" href="CamelObject.html#camel-object-bag-reserve" title="camel_object_bag_reserve ()">camel_object_bag_reserve</a> (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> key</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelObject.html#camel-object-bag-add" title="camel_object_bag_add ()">camel_object_bag_add</a> (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> key</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> object</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelObject.html#camel-object-bag-abort" title="camel_object_bag_abort ()">camel_object_bag_abort</a> (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> key</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelObject.html#camel-object-bag-rekey" title="camel_object_bag_rekey ()">camel_object_bag_rekey</a> (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> object</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> new_key</code></em>);
<span class="returnvalue">GPtrArray</span> * <a class="link" href="CamelObject.html#camel-object-bag-list" title="camel_object_bag_list ()">camel_object_bag_list</a> (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelObject.html#camel-object-bag-remove" title="camel_object_bag_remove ()">camel_object_bag_remove</a> (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> object</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelObject.html#camel-object-bag-destroy" title="camel_object_bag_destroy ()">camel_object_bag_destroy</a> (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelObject.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----CamelObject
+----<a class="link" href="CamelAddress.html" title="CamelAddress">CamelAddress</a>
+----<a class="link" href="CamelKeyFile.html#CamelBlockFile">CamelBlockFile</a>
+----<a class="link" href="CamelKeyFile.html" title="CamelKeyFile">CamelKeyFile</a>
+----<a class="link" href="CamelCertDB.html" title="CamelCertDB">CamelCertDB</a>
+----<a class="link" href="CamelCipherContext.html" title="CamelCipherContext">CamelCipherContext</a>
+----<a class="link" href="CamelDataCache.html" title="CamelDataCache">CamelDataCache</a>
+----<a class="link" href="CamelDataWrapper.html" title="CamelDataWrapper">CamelDataWrapper</a>
+----<a class="link" href="CamelDiscoDiary.html" title="CamelDiscoDiary">CamelDiscoDiary</a>
+----<a class="link" href="CamelFolder.html" title="CamelFolder">CamelFolder</a>
+----<a class="link" href="CamelService.html" title="CamelService">CamelService</a>
+----<a class="link" href="CamelFilterDriver.html" title="CamelFilterDriver">CamelFilterDriver</a>
+----<a class="link" href="CamelFolderSearch.html" title="CamelFolderSearch">CamelFolderSearch</a>
+----<a class="link" href="CamelFolderSummary.html" title="CamelFolderSummary">CamelFolderSummary</a>
+----CamelHTMLParser
+----<a class="link" href="CamelStream.html" title="CamelStream">CamelStream</a>
+----<a class="link" href="CamelIndex.html#CamelIndexCursor">CamelIndexCursor</a>
+----<a class="link" href="CamelIndex.html#CamelIndexName">CamelIndexName</a>
+----<a class="link" href="CamelIndex.html" title="CamelIndex">CamelIndex</a>
+----<a class="link" href="CamelMimeFilter.html" title="CamelMimeFilter">CamelMimeFilter</a>
+----<a class="link" href="CamelMimeParser.html" title="CamelMimeParser">CamelMimeParser</a>
+----<a class="link" href="CamelOfflineJournal.html" title="CamelOfflineJournal">CamelOfflineJournal</a>
+----<a class="link" href="CamelKeyTable.html#CamelPartitionTable">CamelPartitionTable</a>
+----<a class="link" href="CamelKeyTable.html" title="CamelKeyTable">CamelKeyTable</a>
+----<a class="link" href="CamelSasl.html" title="CamelSasl">CamelSasl</a>
+----<a class="link" href="CamelSession.html" title="CamelSession">CamelSession</a>
+----<a class="link" href="CamelStoreSummary.html" title="CamelStoreSummary">CamelStoreSummary</a>
</pre>
</div>
<div class="refsect1">
<a name="CamelObject.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelObject.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelObject-struct"></a><h3>struct CamelObject</h3>
<pre class="programlisting">struct CamelObject;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-ERROR:CAPS"></a><h3>CAMEL_ERROR</h3>
<pre class="programlisting">#define CAMEL_ERROR</pre>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelError"></a><h3>enum CamelError</h3>
<pre class="programlisting">typedef enum {
CAMEL_ERROR_GENERIC /* lazy fallback error */
} CamelError;
</pre>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelParamFlags"></a><h3>enum CamelParamFlags</h3>
<pre class="programlisting">typedef enum {
CAMEL_PARAM_PERSISTENT = 1 << (G_PARAM_USER_SHIFT + 0)
} CamelParamFlags;
</pre>
<p>
These flags extend <span class="type">GParamFlags</span>. Most of the time you will use them
in conjunction with <code class="function">g_object_class_install_property()</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><a name="CAMEL-PARAM-PERSISTENT:CAPS"></a><span class="term"><code class="literal">CAMEL_PARAM_PERSISTENT</code></span></p></td>
<td> The parameter is persistent, which means its value is saved to
<span class="type">"state-filename"</span> during <a class="link" href="CamelObject.html#camel-object-state-write" title="camel_object_state_write ()"><code class="function">camel_object_state_write()</code></a>,
and restored during <a class="link" href="CamelObject.html#camel-object-state-read" title="camel_object_state_read ()"><code class="function">camel_object_state_read()</code></a>.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-state-read"></a><h3>camel_object_state_read ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_object_state_read (<em class="parameter"><code><a class="link" href="CamelObject.html" title="CamelObject"><span class="type">CamelObject</span></a> *object</code></em>);</pre>
<p>
Read persistent object state from <span class="type">"state-filename"</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>a <a class="link" href="CamelObject.html" title="CamelObject"><span class="type">CamelObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>-1 on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-state-write"></a><h3>camel_object_state_write ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_object_state_write (<em class="parameter"><code><a class="link" href="CamelObject.html" title="CamelObject"><span class="type">CamelObject</span></a> *object</code></em>);</pre>
<p>
Write persistent object state <span class="type">"state-filename"</span>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>a <a class="link" href="CamelObject.html" title="CamelObject"><span class="type">CamelObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>-1 on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-get-state-filename"></a><h3>camel_object_get_state_filename ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> * camel_object_get_state_filename (<em class="parameter"><code><a class="link" href="CamelObject.html" title="CamelObject"><span class="type">CamelObject</span></a> *object</code></em>);</pre>
<p>
Returns the name of the file in which persistent property values for
<em class="parameter"><code>object</code></em> are stored. The file is used by <a class="link" href="CamelObject.html#camel-object-state-write" title="camel_object_state_write ()"><code class="function">camel_object_state_write()</code></a>
and <a class="link" href="CamelObject.html#camel-object-state-read" title="camel_object_state_read ()"><code class="function">camel_object_state_read()</code></a> to save and restore object state.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>a <a class="link" href="CamelObject.html" title="CamelObject"><span class="type">CamelObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the name of the persistent property file</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-set-state-filename"></a><h3>camel_object_set_state_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_object_set_state_filename (<em class="parameter"><code><a class="link" href="CamelObject.html" title="CamelObject"><span class="type">CamelObject</span></a> *object</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *state_filename</code></em>);</pre>
<p>
Sets the name of the file in which persistent property values for
<em class="parameter"><code>object</code></em> are stored. The file is used by <a class="link" href="CamelObject.html#camel-object-state-write" title="camel_object_state_write ()"><code class="function">camel_object_state_write()</code></a>
and <a class="link" href="CamelObject.html#camel-object-state-read" title="camel_object_state_read ()"><code class="function">camel_object_state_read()</code></a> to save and restore object state.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>a <a class="link" href="CamelObject.html" title="CamelObject"><span class="type">CamelObject</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>state_filename</code></em> :</span></p></td>
<td>path to a local file</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelObjectBag"></a><h3>CamelObjectBag</h3>
<pre class="programlisting">typedef struct _CamelObjectBag CamelObjectBag;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelCopyFunc"></a><h3>CamelCopyFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gpointer</span> (*CamelCopyFunc) (<em class="parameter"><code><span class="type">gconstpointer</span> object</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-bag-new"></a><h3>camel_object_bag_new ()</h3>
<pre class="programlisting"><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="returnvalue">CamelObjectBag</span></a> * camel_object_bag_new (<em class="parameter"><code><span class="type">GHashFunc</span> key_hash_func</code></em>,
<em class="parameter"><code><span class="type">GEqualFunc</span> key_equal_func</code></em>,
<em class="parameter"><code><a class="link" href="CamelObject.html#CamelCopyFunc" title="CamelCopyFunc ()"><span class="type">CamelCopyFunc</span></a> key_copy_func</code></em>,
<em class="parameter"><code><span class="type">GFreeFunc</span> key_free_func</code></em>);</pre>
<p>
Returns a new object bag. Object bags are keyed hash tables of objects
that can be updated atomically using transaction semantics. Use
<a class="link" href="CamelObject.html#camel-object-bag-destroy" title="camel_object_bag_destroy ()"><code class="function">camel_object_bag_destroy()</code></a> to free the object bag.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>key_hash_func</code></em> :</span></p></td>
<td>a hashing function for keys</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key_equal_func</code></em> :</span></p></td>
<td>a comparison function for keys</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key_copy_func</code></em> :</span></p></td>
<td>a function to copy keys</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key_free_func</code></em> :</span></p></td>
<td>a function to free keys</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a newly-allocated <a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-bag-get"></a><h3>camel_object_bag_get ()</h3>
<pre class="programlisting"><span class="returnvalue">gpointer</span> camel_object_bag_get (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> key</code></em>);</pre>
<p>
Lookup an object by <em class="parameter"><code>key</code></em>. If the key is currently reserved, the function
will block until another thread commits or aborts the reservation. The
caller owns the reference to the returned object. Use <code class="function">g_object_unref()</code>
to unreference it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bag</code></em> :</span></p></td>
<td>a <a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a key</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the object corresponding to <em class="parameter"><code>key</code></em>, or <code class="literal">NULL</code> if not found</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-bag-peek"></a><h3>camel_object_bag_peek ()</h3>
<pre class="programlisting"><span class="returnvalue">gpointer</span> camel_object_bag_peek (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> key</code></em>);</pre>
<p>
Returns the object for <em class="parameter"><code>key</code></em> in <em class="parameter"><code>bag</code></em>, ignoring any reservations. If it
isn't committed, then it isn't considered. This should only be used
where reliable transactional-based state is not required.
</p>
<p>
Unlink other "peek" operations, the caller owns the returned object
reference. Use <code class="function">g_object_unref()</code> to unreference it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bag</code></em> :</span></p></td>
<td>a <a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>an unreserved key</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the object for <em class="parameter"><code>key</code></em>, or <code class="literal">NULL</code> if <em class="parameter"><code>key</code></em> is reserved or not found</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-bag-reserve"></a><h3>camel_object_bag_reserve ()</h3>
<pre class="programlisting"><span class="returnvalue">gpointer</span> camel_object_bag_reserve (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> key</code></em>);</pre>
<p>
Reserves <em class="parameter"><code>key</code></em> in <em class="parameter"><code>bag</code></em>. If <em class="parameter"><code>key</code></em> is already reserved in another thread,
then wait until the reservation has been committed.
</p>
<p>
After reserving <em class="parameter"><code>key</code></em>, you either get a reference to the object
corresponding to <em class="parameter"><code>key</code></em> (similar to <a class="link" href="CamelObject.html#camel-object-bag-get" title="camel_object_bag_get ()"><code class="function">camel_object_bag_get()</code></a>) or you get
<code class="literal">NULL</code>, signifying that you MUST call either <a class="link" href="CamelObject.html#camel-object-bag-add" title="camel_object_bag_add ()"><code class="function">camel_object_bag_add()</code></a> or
<a class="link" href="CamelObject.html#camel-object-bag-abort" title="camel_object_bag_abort ()"><code class="function">camel_object_bag_abort()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bag</code></em> :</span></p></td>
<td>a <a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the key to reserve</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the object for <em class="parameter"><code>key</code></em>, or <code class="literal">NULL</code> if <em class="parameter"><code>key</code></em> is not found</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-bag-add"></a><h3>camel_object_bag_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_object_bag_add (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> key</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> object</code></em>);</pre>
<p>
Adds <em class="parameter"><code>object</code></em> to <em class="parameter"><code>bag</code></em>. The <em class="parameter"><code>key</code></em> MUST have been previously reserved using
<a class="link" href="CamelObject.html#camel-object-bag-reserve" title="camel_object_bag_reserve ()"><code class="function">camel_object_bag_reserve()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bag</code></em> :</span></p></td>
<td>a <a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a reserved key</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>a <span class="type">GObject</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-bag-abort"></a><h3>camel_object_bag_abort ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_object_bag_abort (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> key</code></em>);</pre>
<p>
Aborts a key reservation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bag</code></em> :</span></p></td>
<td>a <a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a reserved key</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-bag-rekey"></a><h3>camel_object_bag_rekey ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_object_bag_rekey (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> object</code></em>,
<em class="parameter"><code><span class="type">gconstpointer</span> new_key</code></em>);</pre>
<p>
Changes the key for <em class="parameter"><code>object</code></em> to <em class="parameter"><code>new_key</code></em>, atomically.
</p>
<p>
It is considered a programming error if <em class="parameter"><code>object</code></em> is not found in <em class="parameter"><code>bag</code></em>.
In such case the function will emit a terminal warning and return.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bag</code></em> :</span></p></td>
<td>a <a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>a <span class="type">GObject</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_key</code></em> :</span></p></td>
<td>a new key for <em class="parameter"><code>object</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-bag-list"></a><h3>camel_object_bag_list ()</h3>
<pre class="programlisting"><span class="returnvalue">GPtrArray</span> * camel_object_bag_list (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>);</pre>
<p>
Returns a <span class="type">GPtrArray</span> of all the objects in the bag. The caller owns
both the array and the object references, so to free the array use:
</p>
<p>
</p>
<div class="informalexample"><pre class="programlisting">
g_ptr_array_foreach (array, g_object_unref, NULL);
g_ptr_array_free (array, TRUE);
</pre></div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bag</code></em> :</span></p></td>
<td>a <a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an array of objects in <em class="parameter"><code>bag</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-bag-remove"></a><h3>camel_object_bag_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_object_bag_remove (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> object</code></em>);</pre>
<p>
Removes <em class="parameter"><code>object</code></em> from <em class="parameter"><code>bag</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>bag</code></em> :</span></p></td>
<td>a <a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td>a <span class="type">GObject</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-object-bag-destroy"></a><h3>camel_object_bag_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_object_bag_destroy (<em class="parameter"><code><a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a> *bag</code></em>);</pre>
<p>
Frees <em class="parameter"><code>bag</code></em>. As a precaution, the function will emit a warning to standard
error and return without freeing <em class="parameter"><code>bag</code></em> if <em class="parameter"><code>bag</code></em> still has reserved keys.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>bag</code></em> :</span></p></td>
<td>a <a class="link" href="CamelObject.html#CamelObjectBag" title="CamelObjectBag"><span class="type">CamelObjectBag</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|