/usr/share/doc/libgnomevfs2-common/html/gnome-vfs-2.0-gnome-vfs-module-callback.html is in libgnomevfs2-dev 1:2.24.4-6.1ubuntu2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gnome-vfs-module-callback: GnomeVFS - Filesystem Abstraction library</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
<link rel="up" href="modules.html" title="Filesystem Modules">
<link rel="prev" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html" title="gnome-vfs-standard-callbacks">
<meta name="generator" content="GTK-Doc V1.25 (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="#gnome-vfs-2.0-gnome-vfs-module-callback.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="modules.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gnome-vfs-2.0-gnome-vfs-standard-callbacks.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><img src="right-insensitive.png" width="16" height="16" border="0"></td>
</tr></table>
<div class="refentry">
<a name="gnome-vfs-2.0-gnome-vfs-module-callback"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gnome-vfs-2.0-gnome-vfs-module-callback.top_of_page"></a>gnome-vfs-module-callback</span></h2>
<p>gnome-vfs-module-callback — functions used by apps if they want to answer to callback invocations by gnome-vfs modules</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-module-callback.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">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallback" title="GnomeVFSModuleCallback ()">*GnomeVFSModuleCallback</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallbackResponse" title="GnomeVFSModuleCallbackResponse ()">*GnomeVFSModuleCallbackResponse</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSAsyncModuleCallback" title="GnomeVFSAsyncModuleCallback ()">*GnomeVFSAsyncModuleCallback</a><span class="c_punctuation">)</span> <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="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-module-callback-set-default" title="gnome_vfs_module_callback_set_default ()">gnome_vfs_module_callback_set_default</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="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-module-callback-push" title="gnome_vfs_module_callback_push ()">gnome_vfs_module_callback_push</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="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-module-callback-pop" title="gnome_vfs_module_callback_pop ()">gnome_vfs_module_callback_pop</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="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-set-default" title="gnome_vfs_async_module_callback_set_default ()">gnome_vfs_async_module_callback_set_default</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="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-push" title="gnome_vfs_async_module_callback_push ()">gnome_vfs_async_module_callback_push</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="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-pop" title="gnome_vfs_async_module_callback_pop ()">gnome_vfs_async_module_callback_pop</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-module-callback.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-module-callback.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GnomeVFSModuleCallback"></a><h3>GnomeVFSModuleCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GnomeVFSModuleCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> in</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> in_size</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> out</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> out_size</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> callback_data</code></em>);</pre>
<p>Modules use a <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallback" title="GnomeVFSModuleCallback ()"><span class="type">GnomeVFSModuleCallback</span></a> to send data to
client applications and request data from them synchronously.</p>
<p>The format of <em class="parameter"><code>in</code></em>
and <em class="parameter"><code>out</code></em>
is determined by the callback name.</p>
<div class="refsect3">
<a name="GnomeVFSModuleCallback.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>in</p></td>
<td class="parameter_description"><p>data passed from module to application.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_size</p></td>
<td class="parameter_description"><p>size of <em class="parameter"><code>in</code></em>
bytes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>data passed from application to module.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_size</p></td>
<td class="parameter_description"><p>size of <em class="parameter"><code>out</code></em>
in bytes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback_data</p></td>
<td class="parameter_description"><p>user data passed when connecting the callback.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSModuleCallbackResponse"></a><h3>GnomeVFSModuleCallbackResponse ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GnomeVFSModuleCallbackResponse<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> response_data</code></em>);</pre>
<p>This is the type of the response function passed to a
<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSAsyncModuleCallback" title="GnomeVFSAsyncModuleCallback ()"><code class="function">GnomeVFSAsyncModuleCallback()</code></a>. It should be called when the async
callback has completed.</p>
<div class="refsect3">
<a name="GnomeVFSModuleCallbackResponse.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>response_data</p></td>
<td class="parameter_description"><p>pass the response data argument originally passed to the async callback.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSAsyncModuleCallback"></a><h3>GnomeVFSAsyncModuleCallback ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GnomeVFSAsyncModuleCallback<span class="c_punctuation">)</span> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gconstpointer"><span class="type">gconstpointer</span></a> in</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> in_size</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> out</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gsize"><span class="type">gsize</span></a> out_size</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> callback_data</code></em>,
<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallbackResponse" title="GnomeVFSModuleCallbackResponse ()"><span class="type">GnomeVFSModuleCallbackResponse</span></a> response</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> response_data</code></em>);</pre>
<p>Modules use a <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallback" title="GnomeVFSModuleCallback ()"><span class="type">GnomeVFSModuleCallback</span></a> to send data to
client applications and request data from them asynchronously.</p>
<p>The application is expected to invoke the <em class="parameter"><code>response</code></em>
with <em class="parameter"><code>response_data</code></em>
when it is able to satisfy the request.</p>
<p>The format of <em class="parameter"><code>in</code></em>
and <em class="parameter"><code>out</code></em>
is determined by the callback name.</p>
<div class="refsect3">
<a name="GnomeVFSAsyncModuleCallback.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>in</p></td>
<td class="parameter_description"><p>data passed from module to application.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in_size</p></td>
<td class="parameter_description"><p>size of <em class="parameter"><code>in</code></em>
bytes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>data passed from application to module.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_size</p></td>
<td class="parameter_description"><p>size of <em class="parameter"><code>out</code></em>
in bytes.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback_data</p></td>
<td class="parameter_description"><p>user data passed when connecting the callback.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>response</p></td>
<td class="parameter_description"><p><a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallbackResponse" title="GnomeVFSModuleCallbackResponse ()"><span class="type">GnomeVFSModuleCallbackResponse</span></a> that must be invoked when the request is satisfied.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>response_data</p></td>
<td class="parameter_description"><p>data that must be passed to <em class="parameter"><code>response</code></em>
when the request is satisfied.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-module-callback-set-default"></a><h3>gnome_vfs_module_callback_set_default ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gnome_vfs_module_callback_set_default (<em class="parameter"><code>const <span class="type">char</span> *callback_name</code></em>,
<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallback" title="GnomeVFSModuleCallback ()"><span class="type">GnomeVFSModuleCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> callback_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_notify</code></em>);</pre>
<p>Set the default callback for <em class="parameter"><code>callback_name</code></em>
to
<em class="parameter"><code>callback</code></em>
. <em class="parameter"><code>callback</code></em>
will be called with <em class="parameter"><code>callback_data</code></em>
on the
same thread as the gnome-vfs operation that invokes it. The default
value is shared for all threads, but setting it is thread-safe.</p>
<p>Use this function if you want to set a handler to be used by your
whole application. You can use <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-module-callback-push" title="gnome_vfs_module_callback_push ()"><code class="function">gnome_vfs_module_callback_push()</code></a> to
set a callback function that will temporarily override the default
on the current thread instead. Or you can also use
<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-set-default" title="gnome_vfs_async_module_callback_set_default ()"><code class="function">gnome_vfs_async_module_callback_set_default()</code></a> to set an async
callback function.</p>
<p>Note: <em class="parameter"><code>destroy_notify</code></em>
may be called on any thread - it is not
guaranteed to be called on the main thread.</p>
<div class="refsect3">
<a name="gnome-vfs-module-callback-set-default.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>callback_name</p></td>
<td class="parameter_description"><p>name of the module callback to set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>function to call when the <em class="parameter"><code>callback</code></em>
is invoked.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback_data</p></td>
<td class="parameter_description"><p>data to pass to <em class="parameter"><code>callback</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy_notify</p></td>
<td class="parameter_description"><p>function to call when <em class="parameter"><code>callback_data</code></em>
is to be freed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-module-callback-push"></a><h3>gnome_vfs_module_callback_push ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gnome_vfs_module_callback_push (<em class="parameter"><code>const <span class="type">char</span> *callback_name</code></em>,
<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSModuleCallback" title="GnomeVFSModuleCallback ()"><span class="type">GnomeVFSModuleCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> callback_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_notify</code></em>);</pre>
<p>Set <em class="parameter"><code>callback</code></em>
as a temprary handler for <em class="parameter"><code>callback_name</code></em>
. <em class="parameter"><code>callback</code></em>
will be called with <em class="parameter"><code>callback_data</code></em>
on the same thread as the
gnome-vfs operation that invokes it. The temporary handler is set
per-thread.</p>
<p>gnome_vfs_module_callback_pop() removes the most recently set
temporary handler. The temporary handlers are treated as a first-in
first-out stack.</p>
<p>Use this function to set a temporary callback handler for a single
call or a few calls. You can use
<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-module-callback-set-default" title="gnome_vfs_module_callback_set_default ()"><code class="function">gnome_vfs_module_callback_set_default()</code></a> to set a callback function
that will establish a permanent global setting for all threads
instead.</p>
<p>Note: <em class="parameter"><code>destroy_notify</code></em>
may be called on any thread - it is not
guaranteed to be called on the main thread.</p>
<div class="refsect3">
<a name="gnome-vfs-module-callback-push.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>callback_name</p></td>
<td class="parameter_description"><p>name of the module callback to set temporarily.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>function to call when the <em class="parameter"><code>callback</code></em>
is invoked.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback_data</p></td>
<td class="parameter_description"><p>data to pass to <em class="parameter"><code>callback</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy_notify</p></td>
<td class="parameter_description"><p>function to call when <em class="parameter"><code>callback_data</code></em>
is to be freed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-module-callback-pop"></a><h3>gnome_vfs_module_callback_pop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gnome_vfs_module_callback_pop (<em class="parameter"><code>const <span class="type">char</span> *callback_name</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-async-module-callback-set-default"></a><h3>gnome_vfs_async_module_callback_set_default ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gnome_vfs_async_module_callback_set_default
(<em class="parameter"><code>const <span class="type">char</span> *callback_name</code></em>,
<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSAsyncModuleCallback" title="GnomeVFSAsyncModuleCallback ()"><span class="type">GnomeVFSAsyncModuleCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> callback_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_notify</code></em>);</pre>
<p>Set the default async callback for <em class="parameter"><code>callback_name</code></em>
to
<em class="parameter"><code>callback</code></em>
. <em class="parameter"><code>callback</code></em>
will be called with <em class="parameter"><code>callback_data</code></em>
from a callback on the main thread. It will be passed a response
function which should be called to signal completion of the callback.
The callback function itself may return in the meantime.</p>
<p>The default value is shared for all threads, but setting it is
thread-safe.</p>
<p>Use this function if you want to globally set a callback handler
for use with async operations.</p>
<p>You can use <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-push" title="gnome_vfs_async_module_callback_push ()"><code class="function">gnome_vfs_async_module_callback_push()</code></a> to set an async
callback function that will temporarily override the default on the
current thread instead. Or you can also use
<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-module-callback-set-default" title="gnome_vfs_module_callback_set_default ()"><code class="function">gnome_vfs_module_callback_set_default()</code></a> to set a regular callback
function.</p>
<p>Note: <em class="parameter"><code>destroy_notify</code></em>
may be called on any thread - it is not
guaranteed to be called on the main thread.</p>
<div class="refsect3">
<a name="gnome-vfs-async-module-callback-set-default.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>callback_name</p></td>
<td class="parameter_description"><p>name of the async module callback to set.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>function to call when <em class="parameter"><code>callback</code></em>
is invoked.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback_data</p></td>
<td class="parameter_description"><p>data to pass to <em class="parameter"><code>callback</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy_notify</p></td>
<td class="parameter_description"><p>function to call when <em class="parameter"><code>callback_data</code></em>
is to be freed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-async-module-callback-push"></a><h3>gnome_vfs_async_module_callback_push ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gnome_vfs_async_module_callback_push (<em class="parameter"><code>const <span class="type">char</span> *callback_name</code></em>,
<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#GnomeVFSAsyncModuleCallback" title="GnomeVFSAsyncModuleCallback ()"><span class="type">GnomeVFSAsyncModuleCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> callback_data</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_notify</code></em>);</pre>
<p>Set <em class="parameter"><code>callback</code></em>
as a temprary async handler for
<em class="parameter"><code>callback_name</code></em>
. <em class="parameter"><code>callback</code></em>
will be called with <em class="parameter"><code>callback_data</code></em>
from a callback on the main thread. It will be passed a response
function which should be called to signal completion of the
callback. The callback function itself may return in the meantime.</p>
<p>The temporary async handler is set per-thread.</p>
<p>gnome_vfs_async_module_callback_pop() removes the most recently set
temporary handler. The temporary async handlers are
treated as a first-in first-out stack.</p>
<p>Use this function to set a temporary async callback handler for a
single call or a few calls. You can use
<a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-set-default" title="gnome_vfs_async_module_callback_set_default ()"><code class="function">gnome_vfs_async_module_callback_set_default()</code></a> to set an async
callback function that will establish a permanent global setting
for all threads instead.</p>
<p>Note: <em class="parameter"><code>destroy_notify</code></em>
may be called on any thread - it is not
guaranteed to be called on the main thread.</p>
<div class="refsect3">
<a name="gnome-vfs-async-module-callback-push.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>callback_name</p></td>
<td class="parameter_description"><p>name of the module callback to set temporarily.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>function to call when <em class="parameter"><code>callback</code></em>
is invoked.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>callback_data</p></td>
<td class="parameter_description"><p>data to pass to <em class="parameter"><code>callback</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy_notify</p></td>
<td class="parameter_description"><p>function to call when <em class="parameter"><code>callback_data</code></em>
is to be freed.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-async-module-callback-pop"></a><h3>gnome_vfs_async_module_callback_pop ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gnome_vfs_async_module_callback_pop (<em class="parameter"><code>const <span class="type">char</span> *callback_name</code></em>);</pre>
<p>Remove the temporary async handler for <em class="parameter"><code>callback_name</code></em>
most recently
set with <a class="link" href="gnome-vfs-2.0-gnome-vfs-module-callback.html#gnome-vfs-async-module-callback-push" title="gnome_vfs_async_module_callback_push ()"><code class="function">gnome_vfs_async_module_callback_push()</code></a>. If another
temporary async handler was previously set on the same thread, it
becomes the current handler. Otherwise, the default async handler,
if any, becomes current.</p>
<p>The temporary async handlers are treated as a first-in first-out
stack.</p>
<div class="refsect3">
<a name="gnome-vfs-async-module-callback-pop.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>callback_name</p></td>
<td class="parameter_description"><p>name of the module callback to remove a temporary handler for.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-module-callback.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|