/usr/share/gtk-doc/html/gconf/gconf-gconf-backend.html is in libgconf2-doc 3.2.6-3ubuntu6.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gconf-backend: GConf Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GConf Reference Manual">
<link rel="up" href="ch01.html" title="Using the GConf library">
<link rel="prev" href="gconf-gconf-client.html" title="GConfClient">
<link rel="next" href="gconf-gconf-engine.html" title="GConfEngine">
<meta name="generator" content="GTK-Doc V1.24 (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="#gconf-gconf-backend.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gconf-gconf-client.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gconf-gconf-engine.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gconf-gconf-backend"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gconf-gconf-backend.top_of_page"></a>gconf-backend</span></h2>
<p>gconf-backend</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gconf-gconf-backend.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="gconf-gconf-backend.html#gconf-address-backend" title="gconf_address_backend ()">gconf_address_backend</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="gconf-gconf-backend.html#gconf-address-resource" title="gconf_address_resource ()">gconf_address_resource</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="gconf-gconf-backend.html#gconf-backend-file" title="gconf_backend_file ()">gconf_backend_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gconf-gconf-backend.html#GConfBackend" title="GConfBackend"><span class="returnvalue">GConfBackend</span></a> *
</td>
<td class="function_name">
<a class="link" href="gconf-gconf-backend.html#gconf-get-backend" title="gconf_get_backend ()">gconf_get_backend</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="gconf-gconf-backend.html#gconf-backend-ref" title="gconf_backend_ref ()">gconf_backend_ref</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="gconf-gconf-backend.html#gconf-backend-unref" title="gconf_backend_unref ()">gconf_backend_unref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="gconf-gconf-sources.html#GConfSource" title="struct GConfSource"><span class="returnvalue">GConfSource</span></a> *
</td>
<td class="function_name">
<a class="link" href="gconf-gconf-backend.html#gconf-backend-resolve-address" title="gconf_backend_resolve_address ()">gconf_backend_resolve_address</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gconf-gconf-backend.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gconf-gconf-backend.html#GConfBackendVTable" title="struct GConfBackendVTable">GConfBackendVTable</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="gconf-gconf-backend.html#GConfBackend" title="GConfBackend">GConfBackend</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gconf-gconf-backend.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="gconf-gconf-backend.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gconf-address-backend"></a><h3>gconf_address_backend ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gconf_address_backend (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *address</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gconf-address-resource"></a><h3>gconf_address_resource ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gconf_address_resource (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *address</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gconf-backend-file"></a><h3>gconf_backend_file ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gconf_backend_file (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *address</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gconf-get-backend"></a><h3>gconf_get_backend ()</h3>
<pre class="programlisting"><a class="link" href="gconf-gconf-backend.html#GConfBackend" title="GConfBackend"><span class="returnvalue">GConfBackend</span></a> *
gconf_get_backend (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *address</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gconf-backend-ref"></a><h3>gconf_backend_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gconf_backend_ref (<em class="parameter"><code><a class="link" href="gconf-gconf-backend.html#GConfBackend" title="GConfBackend"><span class="type">GConfBackend</span></a> *backend</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gconf-backend-unref"></a><h3>gconf_backend_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gconf_backend_unref (<em class="parameter"><code><a class="link" href="gconf-gconf-backend.html#GConfBackend" title="GConfBackend"><span class="type">GConfBackend</span></a> *backend</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gconf-backend-resolve-address"></a><h3>gconf_backend_resolve_address ()</h3>
<pre class="programlisting"><a class="link" href="gconf-gconf-sources.html#GConfSource" title="struct GConfSource"><span class="returnvalue">GConfSource</span></a> *
gconf_backend_resolve_address (<em class="parameter"><code><a class="link" href="gconf-gconf-backend.html#GConfBackend" title="GConfBackend"><span class="type">GConfBackend</span></a> *backend</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *address</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="gconf-gconf-backend.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GConfBackendVTable"></a><h3>struct GConfBackendVTable</h3>
<pre class="programlisting">struct GConfBackendVTable {
/* Set to sizeof (GConfBackendVTable) - used for future proofing */
gsize vtable_size;
void (* shutdown) (GError** err);
GConfSource* (* resolve_address) (const gchar* address,
GError** err);
/* Thread locks. If the backend is thread-safe, then these
* can be NULL. If per-source locks are needed, then these
* calls should lock a mutex stored in the GConfSource.
* If a per-backend lock is needed, then the calls can ignore
* their source argument and lock the whole backend.
*/
void (* lock) (GConfSource* source,
GError** err);
void (* unlock) (GConfSource* source,
GError** err);
/* Report whether a given key (and its subkeys) can be read/written.
* Sources may not permit reading/writing from/to /foo but forbid
* writing to /foo/bar; if a key can be read or written then its
* subkeys may also be read/written.
*
* This field allows backends to be configured so that they only
* store certain kinds of data in certain sections of the GConf
* namespace.
*
* If these functions return an error, they MUST return FALSE as
* well.
*/
gboolean (* readable) (GConfSource* source,
const gchar* key,
GError** err);
gboolean (* writable) (GConfSource* source,
const gchar* key,
GError** err);
/* schema_name filled if NULL or GCONF_VALUE_IGNORE_SUBSEQUENT returned.
if schema_name is NULL, it isn't filled */
GConfValue* (* query_value) (GConfSource* source,
const gchar* key,
const gchar** locales,
gchar** schema_name,
GError** err);
GConfMetaInfo* (* query_metainfo) (GConfSource* source,
const gchar* key,
GError** err);
void (* set_value) (GConfSource* source,
const gchar* key,
const GConfValue* value,
GError** err);
/* Returns list of GConfEntry with key set to a relative
* pathname. In the public client-side API the key
* is always absolute though.
*/
GSList* (* all_entries) (GConfSource* source,
const gchar* dir,
const gchar** locales,
GError** err);
/* Returns list of allocated strings, relative names */
GSList* (* all_subdirs) (GConfSource* source,
const gchar* dir,
GError** err);
void (* unset_value) (GConfSource* source,
const gchar* key,
const gchar* locale,
GError** err);
gboolean (* dir_exists) (GConfSource* source,
const gchar* dir,
GError** err);
void (* remove_dir) (GConfSource* source,
const gchar* dir,
GError** err);
void (* set_schema) (GConfSource* source,
const gchar* key,
const gchar* schema_key,
GError** err);
gboolean (* sync_all) (GConfSource* source,
GError** err);
void (* destroy_source) (GConfSource* source);
/* This is basically used by the test suite */
void (* clear_cache) (GConfSource* source);
/* was used by gconf-sanity-check */
void (* blow_away_locks) (const char *address);
void (* set_notify_func) (GConfSource *source,
GConfSourceNotifyFunc notify_func,
gpointer user_data);
void (* add_listener) (GConfSource *source,
guint id,
const gchar *namespace_section);
void (* remove_listener) (GConfSource *source,
guint id);
};
</pre>
<p>
The <a class="link" href="gconf-gconf-backend.html#GConfBackendVTable" title="struct GConfBackendVTable"><span class="type">GConfBackendVTable</span></a> is a table of methods that any GConf backend must
implement. The dynamically loaded library module should export a function
called <code class="function">gconf_backend_get_vtable()</code> that returns a pointer to a
<a class="link" href="gconf-gconf-backend.html#GConfBackendVTable" title="struct GConfBackendVTable"><span class="type">GConfBackendVTable</span></a>.
</p>
<p>
Here is the specification of the vtable members:
</p>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td><em class="parameter"><code>vtable_size</code></em></td>
<td>
The size of the vtable structure. This is used by the daemon to ensure that
a mismatch between the version of GConf the backend was compiled against and
the version the daemon was compiled against can be handled gracefully. Set
this field to sizeof (GConfBackendVtable).
</td>
</tr>
<tr>
<td><em class="parameter"><code>shutdown</code></em></td>
<td>Called prior to unloading the dynamic
module. Should ensure that no functions or static/global variables from the
module will ever be accessed again. Should free any memory that the backend
no longer needs.
</td>
</tr>
<tr>
<td><em class="parameter"><code>resolve_address</code></em></td>
<td>
Should create a <a class="link" href="gconf-gconf-sources.html#GConfSource" title="struct GConfSource"><span class="type">GConfSource</span></a> for accessing the supplied address. Should set the
<a class="link" href="gconf-gconf-sources.html#GCONF-SOURCE-ALL-READABLE:CAPS"><code class="literal">GCONF_SOURCE_ALL_READABLE</code></a> and <a class="link" href="gconf-gconf-sources.html#GCONF-SOURCE-ALL-WRITEABLE:CAPS"><code class="literal">GCONF_SOURCE_ALL_WRITEABLE</code></a> flags if
appropriate. If these are not set, the backend must implement the <em class="parameter"><code>writable</code></em> and
<em class="parameter"><code>readable</code></em> methods. If <span class="symbol">NULL</span> is returned, then the error should
be set.
</td>
</tr>
<tr>
<td><em class="parameter"><code>lock</code></em></td>
<td>If the backend is thread safe (does its own locking or whatever), then
<em class="parameter"><code>lock</code></em> and <em class="parameter"><code>unlock</code></em> can be <span class="symbol">NULL</span>. If the backend requires a lock
for each source, then <em class="parameter"><code>lock</code></em> and <em class="parameter"><code>unlock</code></em> should lock/unlock that lock. If the
backend has a global lock for all uses of the backend, then <em class="parameter"><code>lock</code></em> and <em class="parameter"><code>unlock</code></em>
should ignore their arguments and lock the entire backend.
</td>
</tr>
<tr>
<td><em class="parameter"><code>unlock</code></em></td>
<td>See description of <em class="parameter"><code>lock</code></em>.</td>
</tr>
<tr>
<td><em class="parameter"><code>readable</code></em></td>
<td>
If the <a class="link" href="gconf-gconf-sources.html#GCONF-SOURCE-ALL-READABLE:CAPS"><code class="literal">GCONF_SOURCE_ALL_READABLE</code></a> flag is set, this method is never called and
may be <span class="symbol">NULL</span>. If <a class="link" href="gconf-gconf-sources.html#GCONF-SOURCE-ALL-READABLE:CAPS"><code class="literal">GCONF_SOURCE_ALL_READABLE</code></a> is unset, and this
method is <span class="symbol">NULL</span>, then the source is write-only. If this method
is implemented, it should return <span class="symbol">TRUE</span> if the given key could be
read from the given source. <span class="symbol">TRUE</span> should be returned even if the
key is unset; this function returns something similar to permissions, it is not
asking whether the key exists. <span class="emphasis"><em>If an error is set, then
<span class="symbol">FALSE</span> must be returned.</em></span>
</td>
</tr>
<tr>
<td><em class="parameter"><code>writable</code></em></td>
<td>Analagous to <em class="parameter"><code>readable</code></em>, but for writing.</td>
</tr>
<tr>
<td><em class="parameter"><code>query_value</code></em></td>
<td>This method must be implemented if the source is readable. It returns the
value of a key. The "locales" argument is a <span class="symbol">NULL</span>-terminated
vector of locale names, where the first locale in the vector is the preferred
locale, the next is the second choice, etc. if the "schema_name" argument is
non-<span class="symbol">NULL</span>, then it should be filled with an allocated string
giving the name of the schema attached to the key, if and only if
<span class="symbol">NULL</span> is returned. This is an optimization to avoid looking up
the same key again in the database if it's unset and we need to ask for its
default value from the schema. If <span class="symbol">NULL</span> is returned, indicating
that the key is unset, then schema_name should not be filled in. If this method
sets an error, <span class="symbol">NULL</span> must be returned. It may not set an error
while also returning a value. The returned value will be destroyed by the
caller, so should be a copy of the backend's internal data.
</td>
</tr>
<tr>
<td><em class="parameter"><code>query_metainfo</code></em></td>
<td>This method must be implemented. If any metainfo is
available about a key, it returns a <a class="link" href="gconf-gconf-value.html#GConfMetaInfo" title="struct GConfMetaInfo"><span class="type">GConfMetaInfo</span></a> with that metainfo set. If
none is available, <span class="symbol">NULL</span> is returned. <span class="symbol">NULL</span>
should also be returned if an error is set.
</td>
</tr>
<tr>
<td><em class="parameter"><code>set_value</code></em></td>
<td>This method must be implemented if the source is
writable. It sets the value of a key. If the key is already set, its value
should be replaced. Setting a value should update the modification time of the
key.
</td>
</tr>
<tr>
<td><em class="parameter"><code>all_entries</code></em></td>
<td>This method must be implemented. It returns a list of all keys in the
given directory for which some information is available (metainfo or
values). The returned list should contain <a class="link" href="gconf-gconf-value.html#GConfEntry" title="struct GConfEntry"><span class="type">GConfEntry</span></a> objects. On error,
<span class="symbol">NULL</span> should be returned and the error set. Subdirectories
should not be included in the returned list. The list and the <a class="link" href="gconf-gconf-value.html#GConfEntry" title="struct GConfEntry"><span class="type">GConfEntry</span></a>
objects will be freed by the caller.
</td>
</tr>
<tr>
<td><em class="parameter"><code>all_subdirs</code></em></td>
<td>This method must be implemented. It returns a list of all the subdirectories in a given
directory. It should return the subdirectories as relative paths, i.e. there
should not be any slashes in the subdirectory name. Each subdirectory in the list
should be an allocated string; the list and the strings will be freed by the caller.
</td>
</tr>
<tr>
<td><em class="parameter"><code>unset_value</code></em></td>
<td>If the given key has a value, then this method should unset the value.
If a value is unset, subsequent calls to <em class="parameter"><code>query_value</code></em> should return
<span class="symbol">NULL</span>. If the locale string passed in to <em class="parameter"><code>unset_value</code></em> is
non-<span class="symbol">NULL</span>, then only the value for that locale should be
unset. If <span class="symbol">NULL</span>, the value should be globally unset for all
locales.
</td>
</tr>
<tr>
<td><em class="parameter"><code>dir_exists</code></em></td>
<td>
Determines whether a directory exists. Should return
<span class="symbol">TRUE</span> if there is a directory with the given name.
</td>
</tr>
<tr>
<td><em class="parameter"><code>remove_dir</code></em></td>
<td>
Should remove a directory, recursively: including all its subdirectories and
all the values and keys inside the directory.
</td>
</tr>
<tr>
<td><em class="parameter"><code>set_schema</code></em></td>
<td>Should associate a schema name with a key.
</td>
</tr>
<tr>
<td><em class="parameter"><code>sync_all</code></em></td>
<td>
Should ensure that all data is stored on permanent media, or whatever makes
sense for the backend. Called periodically by the GConf daemon.
</td>
</tr>
<tr>
<td><em class="parameter"><code>destroy_source</code></em></td>
<td>
Should destroy a source obtained with <em class="parameter"><code>resolve_address</code></em>.
</td>
</tr>
<tr>
<td><em class="parameter"><code>clear_cache</code></em></td>
<td>
Discard any cached data after saving the data to permanent storage.
</td>
</tr>
<tr>
<td><em class="parameter"><code>blow_away_locks</code></em></td>
<td>
Unconditionally discard any locks whether they are stale or otherwise in
order to force the backend to be able to obtain access to its data store.
</td>
</tr>
<tr>
<td><em class="parameter"><code>set_notify_func</code></em></td>
<td>
If the backend wishes to notify the daemon of changes in the value of
keys it must implement this method. In order to notify the daemon
of a change, the backend should invoke the supplied <em class="parameter"><code>notify_func</code></em> with
<em class="parameter"><code>user_data</code></em>. Backends must not notify the daemon of changes which the
daemon has not expressed interest in by adding a listener with
<em class="parameter"><code>add_listener</code></em>. Also, the backend must make every effort to minimise the
number of notifications it emits. For example, if the daemon has added
a listener for /apps and another for /apps/foo and the value of
/apps/foo/bar changes, the backend should only emit a single notification.
</td>
</tr>
<tr>
<td><em class="parameter"><code>add_listener</code></em></td>
<td>
If it is possible for entries to be changed concurrently by another
daemon, the backend may support notifying the daemon (and any listening
clients) of such changes. This function should add a listener to a
section of the tree and when any of the following events occur, the
backend should invoke the notify function with the key that has changed:
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: bullet; ">
<li class="listitem" style="list-style-type: disc"><p>If the entry is set or unset</p></li>
<li class="listitem" style="list-style-type: disc"><p>If the entry's value changes</p></li>
<li class="listitem" style="list-style-type: disc"><p>If the entry's schema name changes</p></li>
<li class="listitem" style="list-style-type: disc"><p>
If the entry is a schema and its value in <span class="emphasis"><em>any</em></span>
locale changes
</p></li>
</ul></div>
Note, the backend should <span class="emphasis"><em>not</em></span> notify the daemon of
any changes that originated from the daemon itself.
</td>
</tr>
<tr>
<td><em class="parameter"><code>remove_listener</code></em></td>
<td>
Remove a listener added with <em class="parameter"><code>add_listener</code></em>. The listener is identified
by the integer supplied.
</td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GConfBackend"></a><h3>GConfBackend</h3>
<pre class="programlisting">typedef struct {
const gchar* name;
guint refcount;
GConfBackendVTable vtable;
GModule* module;
} GConfBackend;
</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|