/usr/share/gtk-doc/html/exo-1/ExoJob.html is in libexo-1-dev 0.6.2-4.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ExoJob</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Exo Reference Manual">
<link rel="up" href="exo-jobs.html" title="Part V. Framework for threaded/asynchronous jobs">
<link rel="prev" href="exo-jobs.html" title="Part V. Framework for threaded/asynchronous jobs">
<link rel="next" href="ExoSimpleJob.html" title="ExoSimpleJob">
<meta name="generator" content="GTK-Doc V1.17 (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="exo-jobs.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="exo-jobs.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">Exo Reference Manual</th>
<td><a accesskey="n" href="ExoSimpleJob.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ExoJob.synopsis" class="shortcut">Top</a>
|
<a href="#ExoJob.description" class="shortcut">Description</a>
|
<a href="#ExoJob.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#ExoJob.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="ExoJob"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ExoJob.top_of_page"></a>ExoJob</span></h2>
<p>ExoJob — Base class for threaded/asynchronous jobs</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ExoJob.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <exo/exo.h>
<a class="link" href="ExoJob.html#ExoJob-struct" title="ExoJob">ExoJob</a>;
<a class="link" href="ExoJob.html" title="ExoJob"><span class="returnvalue">ExoJob</span></a> * <a class="link" href="ExoJob.html#exo-job-launch" title="exo_job_launch ()">exo_job_launch</a> (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>);
<span class="returnvalue">void</span> <a class="link" href="ExoJob.html#exo-job-cancel" title="exo_job_cancel ()">exo_job_cancel</a> (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="ExoJob.html#exo-job-is-cancelled" title="exo_job_is_cancelled ()">exo_job_is_cancelled</a> (<em class="parameter"><code>const <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>);
<span class="returnvalue">GCancellable</span> * <a class="link" href="ExoJob.html#exo-job-get-cancellable" title="exo_job_get_cancellable ()">exo_job_get_cancellable</a> (<em class="parameter"><code>const <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="ExoJob.html#exo-job-set-error-if-cancelled" title="exo_job_set_error_if_cancelled ()">exo_job_set_error_if_cancelled</a> (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="ExoJob.html#exo-job-emit" title="exo_job_emit ()">exo_job_emit</a> (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>,
<em class="parameter"><code><span class="type">guint</span> signal_id</code></em>,
<em class="parameter"><code><span class="type">GQuark</span> signal_detail</code></em>,
<em class="parameter"><code>...</code></em>);
<span class="returnvalue">void</span> <a class="link" href="ExoJob.html#exo-job-info-message" title="exo_job_info_message ()">exo_job_info_message</a> (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
<em class="parameter"><code>...</code></em>);
<span class="returnvalue">void</span> <a class="link" href="ExoJob.html#exo-job-percent" title="exo_job_percent ()">exo_job_percent</a> (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> percent</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="ExoJob.html#exo-job-send-to-mainloop" title="exo_job_send_to_mainloop ()">exo_job_send_to_mainloop</a> (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>,
<em class="parameter"><code><span class="type">GSourceFunc</span> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy_notify</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ExoJob.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----ExoJob
+----<a class="link" href="ExoSimpleJob.html" title="ExoSimpleJob">ExoSimpleJob</a>
</pre>
</div>
<div class="refsect1">
<a name="ExoJob.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="ExoJob.html#ExoJob-error" title='The "error" signal'>error</a>" : <code class="literal">No Hooks</code>
"<a class="link" href="ExoJob.html#ExoJob-finished" title='The "finished" signal'>finished</a>" : <code class="literal">No Hooks</code>
"<a class="link" href="ExoJob.html#ExoJob-info-message" title='The "info-message" signal'>info-message</a>" : <code class="literal">No Hooks</code>
"<a class="link" href="ExoJob.html#ExoJob-percent" title='The "percent" signal'>percent</a>" : <code class="literal">No Hooks</code>
</pre>
</div>
<div class="refsect1">
<a name="ExoJob.description"></a><h2>Description</h2>
<p>
<a class="link" href="ExoJob.html" title="ExoJob">ExoJob</a> is an abstract base class
intended to wrap threaded/asynchronous operations (called jobs here).
It was written because the ways of dealing with threads provided by
GLib are not exactly object-oriented.
</p>
<p>
It can be used to wrap any kind of long-running or possibly-blocking
operation like file operations or communication with web services.
The benefit of using <a class="link" href="ExoJob.html" title="ExoJob">ExoJob</a> is that one
gets an object associated with each operation. After creating the job
the caller can connect to signals like <GTKDOCLINK HREF="ExoJob::error">"error"
</GTKDOCLINK> or "percent". This
design integrates very well with the usual object-oriented design of
applications based on GObject.
</p>
</div>
<div class="refsect1">
<a name="ExoJob.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="ExoJob-struct"></a><h3>ExoJob</h3>
<pre class="programlisting">typedef struct _ExoJob ExoJob;</pre>
<p>
The <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> struct contains only private fields and should not be
directly accessed.
</p>
</div>
<hr>
<div class="refsect2">
<a name="exo-job-launch"></a><h3>exo_job_launch ()</h3>
<pre class="programlisting"><a class="link" href="ExoJob.html" title="ExoJob"><span class="returnvalue">ExoJob</span></a> * exo_job_launch (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>);</pre>
<p>
This functions schedules the <em class="parameter"><code>job</code></em> to be run as soon as possible, in
a separate thread. The caller can connect to signals of the <em class="parameter"><code>job</code></em> prior
or after this call in order to be notified on errors, progress updates
and the end of the operation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>job</code></em> :</span></p></td>
<td>an <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <em class="parameter"><code>job</code></em> itself.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-job-cancel"></a><h3>exo_job_cancel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> exo_job_cancel (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>);</pre>
<p>
Attempts to cancel the operation currently performed by <em class="parameter"><code>job</code></em>. Even
after the cancellation of <em class="parameter"><code>job</code></em>, it may still emit signals, so you
must take care of disconnecting all handlers appropriately if you
cannot handle signals after cancellation.
</p>
<p>
Calling this function when the <em class="parameter"><code>job</code></em> has not been launched yet or
when it has already finished will have no effect.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>job</code></em> :</span></p></td>
<td>a <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-job-is-cancelled"></a><h3>exo_job_is_cancelled ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> exo_job_is_cancelled (<em class="parameter"><code>const <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>);</pre>
<p>
Checks whether <em class="parameter"><code>job</code></em> was previously cancelled
by a call to <a class="link" href="ExoJob.html#exo-job-cancel" title="exo_job_cancel ()"><code class="function">exo_job_cancel()</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>job</code></em> :</span></p></td>
<td>a <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if <em class="parameter"><code>job</code></em> is cancelled.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-job-get-cancellable"></a><h3>exo_job_get_cancellable ()</h3>
<pre class="programlisting"><span class="returnvalue">GCancellable</span> * exo_job_get_cancellable (<em class="parameter"><code>const <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>);</pre>
<p>
Returns the <span class="type">GCancellable</span> that can be used to cancel the <em class="parameter"><code>job</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>job</code></em> :</span></p></td>
<td>an <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <span class="type">GCancellable</span> associated with the <em class="parameter"><code>job</code></em>. It
is owned by the <em class="parameter"><code>job</code></em> and must not be released.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-job-set-error-if-cancelled"></a><h3>exo_job_set_error_if_cancelled ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> exo_job_set_error_if_cancelled (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Sets the <em class="parameter"><code>error</code></em> if the <em class="parameter"><code>job</code></em> was cancelled. This is a convenience
function that is equivalent to
</p>
<div class="informalexample"><pre class="programlisting">
GCancellable *cancellable;
cancellable = exo_job_get_cancllable (job);
g_cancellable_set_error_if_cancelled (cancellable, error);
</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>job</code></em> :</span></p></td>
<td>an <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>error to be set if the <em class="parameter"><code>job</code></em> was cancelled.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the job was cancelled and <em class="parameter"><code>error</code></em> is now set,
<code class="literal">FALSE</code> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-job-emit"></a><h3>exo_job_emit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> exo_job_emit (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>,
<em class="parameter"><code><span class="type">guint</span> signal_id</code></em>,
<em class="parameter"><code><span class="type">GQuark</span> signal_detail</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Sends the signal with <em class="parameter"><code>signal_id</code></em> and <em class="parameter"><code>signal_detail</code></em> to the application's
main loop and waits for listeners to handle it.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>job</code></em> :</span></p></td>
<td>an <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>signal_id</code></em> :</span></p></td>
<td>the signal id.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>signal_detail</code></em> :</span></p></td>
<td>the signal detail.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>a list of parameters to be passed to the signal,
followed by a location for the return value. If the
return type of the signal is G_TYPE_NONE, the return
value location can be omitted.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-job-info-message"></a><h3>exo_job_info_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> exo_job_info_message (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Generates and emits an "info-message" signal and sends it to the
application's main loop.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>job</code></em> :</span></p></td>
<td>an <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a format string.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>parameters for the format string.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-job-percent"></a><h3>exo_job_percent ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> exo_job_percent (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>,
<em class="parameter"><code><span class="type">gdouble</span> percent</code></em>);</pre>
<p>
Emits a "percent" signal and sends it to the application's main
loop. Also makes sure that <em class="parameter"><code>percent</code></em> is between 0.0 and 100.0.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>job</code></em> :</span></p></td>
<td>an <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>percent</code></em> :</span></p></td>
<td>percentage of completeness of the operation.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="exo-job-send-to-mainloop"></a><h3>exo_job_send_to_mainloop ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> exo_job_send_to_mainloop (<em class="parameter"><code><a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job</code></em>,
<em class="parameter"><code><span class="type">GSourceFunc</span> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>,
<em class="parameter"><code><span class="type">GDestroyNotify</span> destroy_notify</code></em>);</pre>
<p>
This functions schedules <em class="parameter"><code>func</code></em> to be run in the main loop (main thread),
waiting for the result (and blocking the job in the meantime).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>job</code></em> :</span></p></td>
<td>an <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>a <span class="type">GSourceFunc</span> callback that will be called in the main thread.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to <em class="parameter"><code>func</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destroy_notify</code></em> :</span></p></td>
<td>a <span class="type">GDestroyNotify</span> for <em class="parameter"><code>user_data</code></em>, or <code class="literal">NULL</code>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The return value of <em class="parameter"><code>func</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="ExoJob.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ExoJob-error"></a><h3>The <code class="literal">"error"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job,
<span class="type">gpointer</span> error,
<span class="type">gpointer</span> user_data) : <code class="literal">No Hooks</code></pre>
<p>
Emitted whenever an error occurs while executing the <em class="parameter"><code>job</code></em>. This signal
may not be emitted from within <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> subclasses. If a subclass wants
to emit an "error" signal (and thereby terminate the operation), it has
to fill the <span class="type">GError</span> structure and abort from its <code class="function">execute()</code> method.
<a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> will automatically emit the "error" signal when the <span class="type">GError</span> is
filled after the <code class="function">execute()</code> method has finished.
</p>
<p>
Callers interested in whether the <em class="parameter"><code>job</code></em> was cancelled can connect to
the "cancelled" signal of the <span class="type">GCancellable</span> returned from
<a class="link" href="ExoJob.html#exo-job-get-cancellable" title="exo_job_get_cancellable ()"><code class="function">exo_job_get_cancellable()</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>job</code></em> :</span></p></td>
<td>an <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <span class="type">GError</span> describing the cause.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ExoJob-finished"></a><h3>The <code class="literal">"finished"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job,
<span class="type">gpointer</span> user_data) : <code class="literal">No Hooks</code></pre>
<p>
This signal will be automatically emitted once the <em class="parameter"><code>job</code></em> finishes
its execution, no matter whether <em class="parameter"><code>job</code></em> completed successfully or
was cancelled by the user. It may not be emitted by subclasses of
<a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> as it is automatically emitted by <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> after the <code class="function">execute()</code>
method has finished.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>job</code></em> :</span></p></td>
<td>an <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ExoJob-info-message"></a><h3>The <code class="literal">"info-message"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job,
<span class="type">gchar</span> *message,
<span class="type">gpointer</span> user_data) : <code class="literal">No Hooks</code></pre>
<p>
This signal is emitted to display information about the status of
the <em class="parameter"><code>job</code></em>. Examples of messages are "Preparing..." or "Cleaning up...".
</p>
<p>
The <em class="parameter"><code>message</code></em> is garanteed to contain valid UTF-8, so it can be
displayed by <span class="type">GtkWidget</span>s out of the box.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>job</code></em> :</span></p></td>
<td>an <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
<td>information to be displayed about <em class="parameter"><code>job</code></em>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ExoJob-percent"></a><h3>The <code class="literal">"percent"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a> *job,
<span class="type">gdouble</span> percent,
<span class="type">gpointer</span> user_data) : <code class="literal">No Hooks</code></pre>
<p>
This signal is emitted to present the overall progress of the
operation. The <em class="parameter"><code>percent</code></em> value is garantied to be a value between
0.0 and 100.0.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>job</code></em> :</span></p></td>
<td>an <a class="link" href="ExoJob.html" title="ExoJob"><span class="type">ExoJob</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>percent</code></em> :</span></p></td>
<td>the percentage of completeness.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="ExoJob.see-also"></a><h2>See Also</h2>
<a class="link" href="ExoSimpleJob.html" title="ExoSimpleJob">ExoSimpleJob</a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|