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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>camel-operation</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Fundamentals.html" title="Fundamentals">
<link rel="prev" href="camel-CamelObject.html" title="CamelObject">
<link rel="next" href="camel-camel-url.html" title="camel-url">
<meta name="generator" content="GTK-Doc V1.14 (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-CamelObject.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-url.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-camel-operation.synopsis" class="shortcut">Top</a>
|
<a href="#camel-camel-operation.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="camel-operation">
<a name="camel-camel-operation"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-camel-operation.top_of_page"></a>camel-operation</span></h2>
<p>camel-operation</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="camel-camel-operation.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a>;
<span class="returnvalue">void</span> (<a class="link" href="camel-camel-operation.html#CamelOperationStatusFunc" title="CamelOperationStatusFunc ()">*CamelOperationStatusFunc</a>) (<em class="parameter"><code><span class="type">struct _CamelOperation</span> *op</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *what</code></em>,
<em class="parameter"><code><span class="type">gint</span> pc</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
enum <a class="link" href="camel-camel-operation.html#camel-operation-status-t" title="enum camel_operation_status_t">camel_operation_status_t</a>;
<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="returnvalue">CamelOperation</span></a> * <a class="link" href="camel-camel-operation.html#camel-operation-new" title="camel_operation_new ()">camel_operation_new</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperationStatusFunc" title="CamelOperationStatusFunc ()"><span class="type">CamelOperationStatusFunc</span></a> status</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> status_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-mute" title="camel_operation_mute ()">camel_operation_mute</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-ref" title="camel_operation_ref ()">camel_operation_ref</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-unref" title="camel_operation_unref ()">camel_operation_unref</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-cancel" title="camel_operation_cancel ()">camel_operation_cancel</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-uncancel" title="camel_operation_uncancel ()">camel_operation_uncancel</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);
<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="returnvalue">CamelOperation</span></a> * <a class="link" href="camel-camel-operation.html#camel-operation-register" title="camel_operation_register ()">camel_operation_register</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-unregister" title="camel_operation_unregister ()">camel_operation_unregister</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-cancel-block" title="camel_operation_cancel_block ()">camel_operation_cancel_block</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-cancel-unblock" title="camel_operation_cancel_unblock ()">camel_operation_cancel_unblock</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="camel-camel-operation.html#camel-operation-cancel-check" title="camel_operation_cancel_check ()">camel_operation_cancel_check</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="camel-camel-operation.html#camel-operation-cancel-fd" title="camel_operation_cancel_fd ()">camel_operation_cancel_fd</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);
struct <span class="returnvalue">PRFileDesc</span> * <a class="link" href="camel-camel-operation.html#camel-operation-cancel-prfd" title="camel_operation_cancel_prfd ()">camel_operation_cancel_prfd</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);
<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="returnvalue">CamelOperation</span></a> * <a class="link" href="camel-camel-operation.html#camel-operation-registered" title="camel_operation_registered ()">camel_operation_registered</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-start" title="camel_operation_start ()">camel_operation_start</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *what</code></em>,
<em class="parameter"><code>...</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-start-transient" title="camel_operation_start_transient ()">camel_operation_start_transient</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *what</code></em>,
<em class="parameter"><code>...</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-progress" title="camel_operation_progress ()">camel_operation_progress</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>,
<em class="parameter"><code><span class="type">gint</span> pc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-progress-count" title="camel_operation_progress_count ()">camel_operation_progress_count</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>,
<em class="parameter"><code><span class="type">gint</span> sofar</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-end" title="camel_operation_end ()">camel_operation_end</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="camel-camel-operation.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="camel-camel-operation.details"></a><h2>Details</h2>
<div class="refsect2" title="CamelOperation">
<a name="CamelOperation"></a><h3>CamelOperation</h3>
<pre class="programlisting">typedef struct _CamelOperation CamelOperation;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="CamelOperationStatusFunc ()">
<a name="CamelOperationStatusFunc"></a><h3>CamelOperationStatusFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*CamelOperationStatusFunc) (<em class="parameter"><code><span class="type">struct _CamelOperation</span> *op</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *what</code></em>,
<em class="parameter"><code><span class="type">gint</span> pc</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>op</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>what</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pc</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="enum camel_operation_status_t">
<a name="camel-operation-status-t"></a><h3>enum camel_operation_status_t</h3>
<pre class="programlisting">typedef enum _camel_operation_status_t {
CAMEL_OPERATION_START = -1,
CAMEL_OPERATION_END = -2
} camel_operation_status_t;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="camel_operation_new ()">
<a name="camel-operation-new"></a><h3>camel_operation_new ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="returnvalue">CamelOperation</span></a> * camel_operation_new (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperationStatusFunc" title="CamelOperationStatusFunc ()"><span class="type">CamelOperationStatusFunc</span></a> status</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> status_data</code></em>);</pre>
<p>
Create a new camel operation handle. Camel operation handles can
be used in a multithreaded application (or a single operation
handle can be used in a non threaded appliation) to cancel running
operations and to obtain notification messages of the internal
status of messages.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
<td>Callback for receiving status messages. This will always
be called with an internal lock held.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>status_data</code></em> :</span></p></td>
<td>User data.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new operation handle.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_mute ()">
<a name="camel-operation-mute"></a><h3>camel_operation_mute ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_mute (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);</pre>
<p>
mutes a camel operation permanently. from this point on you will never
receive operation updates, even if more are sent.
</p>
</div>
<hr>
<div class="refsect2" title="camel_operation_ref ()">
<a name="camel-operation-ref"></a><h3>camel_operation_ref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_ref (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);</pre>
<p>
Add a reference to the CamelOperation <em class="parameter"><code>cc</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>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_unref ()">
<a name="camel-operation-unref"></a><h3>camel_operation_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_unref (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);</pre>
<p>
Unref and potentially free <em class="parameter"><code>cc</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>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_cancel ()">
<a name="camel-operation-cancel"></a><h3>camel_operation_cancel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_cancel (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);</pre>
<p>
Cancel a given operation. If <em class="parameter"><code>cc</code></em> is NULL then all outstanding
operations are cancelled.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_uncancel ()">
<a name="camel-operation-uncancel"></a><h3>camel_operation_uncancel ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_uncancel (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);</pre>
<p>
Uncancel a cancelled operation. If <em class="parameter"><code>cc</code></em> is NULL then the current
operation is uncancelled.
</p>
<p>
This is useful, if e.g. you need to do some cleaning up where a
cancellation lying around in the same thread will abort any
processing.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_register ()">
<a name="camel-operation-register"></a><h3>camel_operation_register ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="returnvalue">CamelOperation</span></a> * camel_operation_register (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);</pre>
<p>
Register a thread or the main thread for cancellation through <em class="parameter"><code>cc</code></em>.
If <em class="parameter"><code>cc</code></em> is NULL, then a new cancellation is created for this thread.
</p>
<p>
All calls to <code class="function">operation_register()</code> should save their value and call
operation_register again with that, to automatically stack
registrations.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the previously registered operatoin.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_unregister ()">
<a name="camel-operation-unregister"></a><h3>camel_operation_unregister ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_unregister (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);</pre>
<p>
Unregister the current thread for all cancellations.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_cancel_block ()">
<a name="camel-operation-cancel-block"></a><h3>camel_operation_cancel_block ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_cancel_block (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);</pre>
<p>
Block cancellation for this operation. If <em class="parameter"><code>cc</code></em> is NULL, then the
current thread is blocked.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_cancel_unblock ()">
<a name="camel-operation-cancel-unblock"></a><h3>camel_operation_cancel_unblock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_cancel_unblock (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);</pre>
<p>
Unblock cancellation, when the unblock count reaches the block
count, then this operation can be cancelled. If <em class="parameter"><code>cc</code></em> is NULL, then
the current thread is unblocked.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_cancel_check ()">
<a name="camel-operation-cancel-check"></a><h3>camel_operation_cancel_check ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_operation_cancel_check (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);</pre>
<p>
Check if cancellation has been applied to <em class="parameter"><code>cc</code></em>. If <em class="parameter"><code>cc</code></em> is NULL,
then the CamelOperation registered for the current thread is used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the operation has been cancelled.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_cancel_fd ()">
<a name="camel-operation-cancel-fd"></a><h3>camel_operation_cancel_fd ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_operation_cancel_fd (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);</pre>
<p>
Retrieve a file descriptor that can be waited on (select, or poll)
for read, to asynchronously detect cancellation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The fd, or -1 if cancellation is not available
(blocked, or has not been registered for this thread).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_cancel_prfd ()">
<a name="camel-operation-cancel-prfd"></a><h3>camel_operation_cancel_prfd ()</h3>
<pre class="programlisting">struct <span class="returnvalue">PRFileDesc</span> * camel_operation_cancel_prfd (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);</pre>
<p>
Retrieve a file descriptor that can be waited on (select, or poll)
for read, to asynchronously detect cancellation.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The fd, or NULL if cancellation is not available
(blocked, or has not been registered for this thread).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_registered ()">
<a name="camel-operation-registered"></a><h3>camel_operation_registered ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="returnvalue">CamelOperation</span></a> * camel_operation_registered (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the registered operation, or <code class="literal">NULL</code> if none registered.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_start ()">
<a name="camel-operation-start"></a><h3>camel_operation_start ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_start (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *what</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Report the start of an operation. All start operations should have
similar end operations.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>what</code></em> :</span></p></td>
<td>action being performed (printf-style format string)
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>varargs
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_start_transient ()">
<a name="camel-operation-start-transient"></a><h3>camel_operation_start_transient ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_start_transient (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *what</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Start a transient event. We only update this to the display if it
takes very long to process, and if we do, we then go back to the
previous state when finished.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>what</code></em> :</span></p></td>
<td>printf-style format string describing the action being performed
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>varargs
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_progress ()">
<a name="camel-operation-progress"></a><h3>camel_operation_progress ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_progress (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>,
<em class="parameter"><code><span class="type">gint</span> pc</code></em>);</pre>
<p>
Report progress on the current operation. If <em class="parameter"><code>cc</code></em> is NULL, then the
currently registered operation is used. <em class="parameter"><code>pc</code></em> reports the current
percentage of completion, which should be in the range of 0 to 100.
</p>
<p>
If the total percentage is not know, then use
<a class="link" href="camel-camel-operation.html#camel-operation-progress-count" title="camel_operation_progress_count ()"><code class="function">camel_operation_progress_count()</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>cc</code></em> :</span></p></td>
<td>Operation to report to.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>pc</code></em> :</span></p></td>
<td>Percent complete, 0 to 100.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_progress_count ()">
<a name="camel-operation-progress-count"></a><h3>camel_operation_progress_count ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_progress_count (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>,
<em class="parameter"><code><span class="type">gint</span> sofar</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_end ()">
<a name="camel-operation-end"></a><h3>camel_operation_end ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_end (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation"><span class="type">CamelOperation</span></a> *cc</code></em>);</pre>
<p>
Report the end of an operation. If <em class="parameter"><code>cc</code></em> is NULL, then the currently
registered operation is notified.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
<td>operation context
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
