4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>camel-operation</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="Fundamentals.html" title="Fundamentals">
9
9
<link rel="prev" href="camel-CamelObject.html" title="CamelObject">
10
10
<link rel="next" href="camel-camel-url.html" title="camel-url">
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.14 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="classes.html" title="Part I. Camel Classes">
14
<link rel="chapter" href="ClassTree.html" title="Class Hierarchy">
15
<link rel="chapter" href="Fundamentals.html" title="Fundamentals">
16
<link rel="chapter" href="Streams.html" title="Streams">
17
<link rel="chapter" href="StreamFilters.html" title="Stream Filters">
18
<link rel="chapter" href="Services.html" title="Services">
19
<link rel="chapter" href="Filters.html" title="Filters">
20
<link rel="chapter" href="Folders.html" title="Folders">
21
<link rel="chapter" href="SearchFolders.html" title="Search Folders">
22
<link rel="chapter" href="Addresses.html" title="Addresses">
23
<link rel="chapter" href="Crypto.html" title="Crypto Contexts">
24
<link rel="chapter" href="MIME.html" title="MIME Objects">
25
<link rel="chapter" href="Storage.html" title="Metadata Storage">
26
<link rel="chapter" href="Utilities.html" title="Utilities">
27
<link rel="chapter" href="Deprecated.html" title="Deprecated Objects">
28
<link rel="index" href="ix01.html" title="Index">
29
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
31
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
32
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
53
36
<td valign="top" align="right"></td>
54
37
</tr></table></div>
55
<div class="refsynopsisdiv" title="Synopsis">
38
<div class="refsynopsisdiv">
56
39
<a name="camel-camel-operation.synopsis"></a><h2>Synopsis</h2>
57
<pre class="synopsis">
58
<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a>;
59
void (<a class="link" href="camel-camel-operation.html#CamelOperationStatusFunc" title="CamelOperationStatusFunc ()">*CamelOperationStatusFunc</a>) (struct _CamelOperation *op,
61
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
64
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
67
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
40
<pre class="synopsis"> <a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a>;
41
<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>,
42
<em class="parameter"><code>const <span class="type">gchar</span> *what</code></em>,
43
<em class="parameter"><code><span class="type">gint</span> pc</code></em>,
44
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
69
45
enum <a class="link" href="camel-camel-operation.html#camel-operation-status-t" title="enum camel_operation_status_t">camel_operation_status_t</a>;
70
<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> * <a class="link" href="camel-camel-operation.html#camel-operation-new" title="camel_operation_new ()">camel_operation_new</a> (<a class="link" href="camel-camel-operation.html#CamelOperationStatusFunc" title="CamelOperationStatusFunc ()">CamelOperationStatusFunc</a> status,
72
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
73
>gpointer</a> status_data);
74
void <a class="link" href="camel-camel-operation.html#camel-operation-mute" title="camel_operation_mute ()">camel_operation_mute</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);
75
void <a class="link" href="camel-camel-operation.html#camel-operation-ref" title="camel_operation_ref ()">camel_operation_ref</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);
76
void <a class="link" href="camel-camel-operation.html#camel-operation-unref" title="camel_operation_unref ()">camel_operation_unref</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);
77
void <a class="link" href="camel-camel-operation.html#camel-operation-cancel" title="camel_operation_cancel ()">camel_operation_cancel</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);
78
void <a class="link" href="camel-camel-operation.html#camel-operation-uncancel" title="camel_operation_uncancel ()">camel_operation_uncancel</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);
79
<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> * <a class="link" href="camel-camel-operation.html#camel-operation-register" title="camel_operation_register ()">camel_operation_register</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);
80
void <a class="link" href="camel-camel-operation.html#camel-operation-unregister" title="camel_operation_unregister ()">camel_operation_unregister</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);
81
void <a class="link" href="camel-camel-operation.html#camel-operation-cancel-block" title="camel_operation_cancel_block ()">camel_operation_cancel_block</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);
82
void <a class="link" href="camel-camel-operation.html#camel-operation-cancel-unblock" title="camel_operation_cancel_unblock ()">camel_operation_cancel_unblock</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);
84
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
85
>gint</a> <a class="link" href="camel-camel-operation.html#camel-operation-cancel-check" title="camel_operation_cancel_check ()">camel_operation_cancel_check</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);
87
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
88
>gint</a> <a class="link" href="camel-camel-operation.html#camel-operation-cancel-fd" title="camel_operation_cancel_fd ()">camel_operation_cancel_fd</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);
89
struct PRFileDesc * <a class="link" href="camel-camel-operation.html#camel-operation-cancel-prfd" title="camel_operation_cancel_prfd ()">camel_operation_cancel_prfd</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);
90
<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> * <a class="link" href="camel-camel-operation.html#camel-operation-registered" title="camel_operation_registered ()">camel_operation_registered</a> (void);
91
void <a class="link" href="camel-camel-operation.html#camel-operation-start" title="camel_operation_start ()">camel_operation_start</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc,
93
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
96
void <a class="link" href="camel-camel-operation.html#camel-operation-start-transient" title="camel_operation_start_transient ()">camel_operation_start_transient</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc,
98
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
101
void <a class="link" href="camel-camel-operation.html#camel-operation-progress" title="camel_operation_progress ()">camel_operation_progress</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc,
103
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
105
void <a class="link" href="camel-camel-operation.html#camel-operation-progress-count" title="camel_operation_progress_count ()">camel_operation_progress_count</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc,
107
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
109
void <a class="link" href="camel-camel-operation.html#camel-operation-end" title="camel_operation_end ()">camel_operation_end</a> (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);
46
<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>,
47
<em class="parameter"><code><span class="type">gpointer</span> status_data</code></em>);
48
<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>);
49
<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>);
50
<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>);
51
<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>);
52
<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>);
53
<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>);
54
<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>);
55
<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>);
56
<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>);
57
<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>);
58
<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>);
59
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>);
60
<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>);
61
<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>,
62
<em class="parameter"><code>const <span class="type">gchar</span> *what</code></em>,
63
<em class="parameter"><code>...</code></em>);
64
<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>,
65
<em class="parameter"><code>const <span class="type">gchar</span> *what</code></em>,
66
<em class="parameter"><code>...</code></em>);
67
<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>,
68
<em class="parameter"><code><span class="type">gint</span> pc</code></em>);
69
<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>,
70
<em class="parameter"><code><span class="type">gint</span> sofar</code></em>);
71
<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>);
112
<div class="refsect1" title="Description">
74
<div class="refsect1" lang="en">
113
75
<a name="camel-camel-operation.description"></a><h2>Description</h2>
117
<div class="refsect1" title="Details">
79
<div class="refsect1" lang="en">
118
80
<a name="camel-camel-operation.details"></a><h2>Details</h2>
119
<div class="refsect2" title="CamelOperation">
81
<div class="refsect2" lang="en">
120
82
<a name="CamelOperation"></a><h3>CamelOperation</h3>
121
83
<pre class="programlisting">typedef struct _CamelOperation CamelOperation;</pre>
126
<div class="refsect2" title="CamelOperationStatusFunc ()">
88
<div class="refsect2" lang="en">
127
89
<a name="CamelOperationStatusFunc"></a><h3>CamelOperationStatusFunc ()</h3>
128
<pre class="programlisting">void (*CamelOperationStatusFunc) (struct _CamelOperation *op,
130
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
133
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
136
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
137
>gpointer</a> data);</pre>
90
<pre class="programlisting"><span class="returnvalue">void</span> (*CamelOperationStatusFunc) (<em class="parameter"><code><span class="type">struct _CamelOperation</span> *op</code></em>,
91
<em class="parameter"><code>const <span class="type">gchar</span> *what</code></em>,
92
<em class="parameter"><code><span class="type">gint</span> pc</code></em>,
93
<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
140
96
<div class="variablelist"><table border="0">
215
<div class="refsect2" title="camel_operation_mute ()">
167
<div class="refsect2" lang="en">
216
168
<a name="camel-operation-mute"></a><h3>camel_operation_mute ()</h3>
217
<pre class="programlisting">void camel_operation_mute (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
169
<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>
219
171
mutes a camel operation permanently. from this point on you will never
220
172
receive operation updates, even if more are sent.</p>
223
<div class="variablelist"><table border="0">
224
<col align="left" valign="top">
226
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
233
<div class="refsect2" title="camel_operation_ref ()">
175
<div class="refsect2" lang="en">
234
176
<a name="camel-operation-ref"></a><h3>camel_operation_ref ()</h3>
235
<pre class="programlisting">void camel_operation_ref (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
177
<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>
237
179
Add a reference to the CamelOperation <em class="parameter"><code>cc</code></em>.</p>
240
180
<div class="variablelist"><table border="0">
241
181
<col align="left" valign="top">
243
183
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
244
<td> operation context
184
<td>operation context
250
<div class="refsect2" title="camel_operation_unref ()">
190
<div class="refsect2" lang="en">
251
191
<a name="camel-operation-unref"></a><h3>camel_operation_unref ()</h3>
252
<pre class="programlisting">void camel_operation_unref (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
192
<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>
254
194
Unref and potentially free <em class="parameter"><code>cc</code></em>.</p>
257
195
<div class="variablelist"><table border="0">
258
196
<col align="left" valign="top">
260
198
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
261
<td> operation context
199
<td>operation context
267
<div class="refsect2" title="camel_operation_cancel ()">
205
<div class="refsect2" lang="en">
268
206
<a name="camel-operation-cancel"></a><h3>camel_operation_cancel ()</h3>
269
<pre class="programlisting">void camel_operation_cancel (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
207
<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>
271
209
Cancel a given operation. If <em class="parameter"><code>cc</code></em> is NULL then all outstanding
272
210
operations are cancelled.</p>
275
211
<div class="variablelist"><table border="0">
276
212
<col align="left" valign="top">
278
214
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
279
<td> operation context
215
<td>operation context
285
<div class="refsect2" title="camel_operation_uncancel ()">
221
<div class="refsect2" lang="en">
286
222
<a name="camel-operation-uncancel"></a><h3>camel_operation_uncancel ()</h3>
287
<pre class="programlisting">void camel_operation_uncancel (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
223
<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>
289
225
Uncancel a cancelled operation. If <em class="parameter"><code>cc</code></em> is NULL then the current
290
226
operation is uncancelled.
339
<div class="refsect2" title="camel_operation_unregister ()">
271
<div class="refsect2" lang="en">
340
272
<a name="camel-operation-unregister"></a><h3>camel_operation_unregister ()</h3>
341
<pre class="programlisting">void camel_operation_unregister (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
273
<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>
343
275
Unregister the current thread for all cancellations.</p>
346
276
<div class="variablelist"><table border="0">
347
277
<col align="left" valign="top">
349
279
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
350
<td> operation context
280
<td>operation context
356
<div class="refsect2" title="camel_operation_cancel_block ()">
286
<div class="refsect2" lang="en">
357
287
<a name="camel-operation-cancel-block"></a><h3>camel_operation_cancel_block ()</h3>
358
<pre class="programlisting">void camel_operation_cancel_block (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
288
<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>
360
290
Block cancellation for this operation. If <em class="parameter"><code>cc</code></em> is NULL, then the
361
291
current thread is blocked.</p>
364
292
<div class="variablelist"><table border="0">
365
293
<col align="left" valign="top">
367
295
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
368
<td> operation context
296
<td>operation context
374
<div class="refsect2" title="camel_operation_cancel_unblock ()">
302
<div class="refsect2" lang="en">
375
303
<a name="camel-operation-cancel-unblock"></a><h3>camel_operation_cancel_unblock ()</h3>
376
<pre class="programlisting">void camel_operation_cancel_unblock (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
304
<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>
378
306
Unblock cancellation, when the unblock count reaches the block
379
307
count, then this operation can be cancelled. If <em class="parameter"><code>cc</code></em> is NULL, then
380
308
the current thread is unblocked.</p>
383
309
<div class="variablelist"><table border="0">
384
310
<col align="left" valign="top">
386
312
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
387
<td> operation context
313
<td>operation context
393
<div class="refsect2" title="camel_operation_cancel_check ()">
319
<div class="refsect2" lang="en">
394
320
<a name="camel-operation-cancel-check"></a><h3>camel_operation_cancel_check ()</h3>
395
<pre class="programlisting"><a
396
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
397
>gint</a> camel_operation_cancel_check (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
321
<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>
399
323
Check if cancellation has been applied to <em class="parameter"><code>cc</code></em>. If <em class="parameter"><code>cc</code></em> is NULL,
400
324
then the CamelOperation registered for the current thread is used.</p>
403
325
<div class="variablelist"><table border="0">
404
326
<col align="left" valign="top">
407
329
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
408
<td> operation context
330
<td>operation context
474
<div class="refsect2" title="camel_operation_registered ()">
390
<div class="refsect2" lang="en">
475
391
<a name="camel-operation-registered"></a><h3>camel_operation_registered ()</h3>
476
<pre class="programlisting"><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> * camel_operation_registered (void);</pre>
392
<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>
481
393
<div class="variablelist"><table border="0">
482
394
<col align="left" valign="top">
484
396
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
485
<td> the registered operation, or <a
486
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL--CAPS"
487
><code class="literal">NULL</code></a> if none registered.
397
<td> the registered operation, or <code class="literal">NULL</code> if none registered.
493
<div class="refsect2" title="camel_operation_start ()">
403
<div class="refsect2" lang="en">
494
404
<a name="camel-operation-start"></a><h3>camel_operation_start ()</h3>
495
<pre class="programlisting">void camel_operation_start (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc,
497
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
405
<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>,
406
<em class="parameter"><code>const <span class="type">gchar</span> *what</code></em>,
407
<em class="parameter"><code>...</code></em>);</pre>
501
409
Report the start of an operation. All start operations should have
502
410
similar end operations.</p>
505
411
<div class="variablelist"><table border="0">
506
412
<col align="left" valign="top">
509
415
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
510
<td> operation context
416
<td>operation context
514
420
<td><p><span class="term"><em class="parameter"><code>what</code></em> :</span></p></td>
515
<td> action being performed (printf-style format string)
421
<td>action being performed (printf-style format string)
519
425
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
527
<div class="refsect2" title="camel_operation_start_transient ()">
433
<div class="refsect2" lang="en">
528
434
<a name="camel-operation-start-transient"></a><h3>camel_operation_start_transient ()</h3>
529
<pre class="programlisting">void camel_operation_start_transient (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc,
531
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
435
<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>,
436
<em class="parameter"><code>const <span class="type">gchar</span> *what</code></em>,
437
<em class="parameter"><code>...</code></em>);</pre>
535
439
Start a transient event. We only update this to the display if it
536
440
takes very long to process, and if we do, we then go back to the
537
441
previous state when finished.</p>
540
442
<div class="variablelist"><table border="0">
541
443
<col align="left" valign="top">
544
446
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
545
<td> operation context
447
<td>operation context
549
451
<td><p><span class="term"><em class="parameter"><code>what</code></em> :</span></p></td>
550
<td> printf-style format string describing the action being performed
452
<td>printf-style format string describing the action being performed
554
456
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
562
<div class="refsect2" title="camel_operation_progress ()">
464
<div class="refsect2" lang="en">
563
465
<a name="camel-operation-progress"></a><h3>camel_operation_progress ()</h3>
564
<pre class="programlisting">void camel_operation_progress (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc,
566
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
466
<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>,
467
<em class="parameter"><code><span class="type">gint</span> pc</code></em>);</pre>
569
469
Report progress on the current operation. If <em class="parameter"><code>cc</code></em> is NULL, then the
570
470
currently registered operation is used. <em class="parameter"><code>pc</code></em> reports the current
574
474
If the total percentage is not know, then use
575
475
<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>
578
476
<div class="variablelist"><table border="0">
579
477
<col align="left" valign="top">
582
480
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
583
<td> Operation to report to.
481
<td>Operation to report to.
587
485
<td><p><span class="term"><em class="parameter"><code>pc</code></em> :</span></p></td>
588
<td> Percent complete, 0 to 100.
486
<td>Percent complete, 0 to 100.
595
<div class="refsect2" title="camel_operation_progress_count ()">
493
<div class="refsect2" lang="en">
596
494
<a name="camel-operation-progress-count"></a><h3>camel_operation_progress_count ()</h3>
597
<pre class="programlisting">void camel_operation_progress_count (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc,
599
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
600
>gint</a> sofar);</pre>
495
<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>,
496
<em class="parameter"><code><span class="type">gint</span> sofar</code></em>);</pre>
605
497
<div class="variablelist"><table border="0">
606
498
<col align="left" valign="top">
609
500
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
610
<td> operation context
614
<td><p><span class="term"><em class="parameter"><code>sofar</code></em> :</span></p></td>
501
<td>operation context
622
<div class="refsect2" title="camel_operation_end ()">
507
<div class="refsect2" lang="en">
623
508
<a name="camel-operation-end"></a><h3>camel_operation_end ()</h3>
624
<pre class="programlisting">void camel_operation_end (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
509
<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>
626
511
Report the end of an operation. If <em class="parameter"><code>cc</code></em> is NULL, then the currently
627
512
registered operation is notified.</p>
630
513
<div class="variablelist"><table border="0">
631
514
<col align="left" valign="top">
633
516
<td><p><span class="term"><em class="parameter"><code>cc</code></em> :</span></p></td>
634
<td> operation context
517
<td>operation context