53
53
<td valign="top" align="right"></td>
54
54
</tr></table></div>
55
<div class="refsynopsisdiv">
55
<div class="refsynopsisdiv" title="Synopsis">
56
56
<a name="camel-camel-operation.synopsis"></a><h2>Synopsis</h2>
57
57
<pre class="synopsis">
58
58
<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a>;
59
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"
63
69
enum <a class="link" href="camel-camel-operation.html#camel-operation-status-t" title="enum camel_operation_status_t">camel_operation_status_t</a>;
64
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,
65
gpointer status_data);
72
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
73
>gpointer</a> status_data);
66
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);
67
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);
68
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);
72
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);
73
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);
74
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);
75
gint <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);
76
gint <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);
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);
77
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);
78
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);
79
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"
82
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"
85
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"
87
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"
89
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);
92
<div class="refsect1" lang="en">
112
<div class="refsect1" title="Description">
93
113
<a name="camel-camel-operation.description"></a><h2>Description</h2>
97
<div class="refsect1" lang="en">
117
<div class="refsect1" title="Details">
98
118
<a name="camel-camel-operation.details"></a><h2>Details</h2>
99
<div class="refsect2" lang="en">
119
<div class="refsect2" title="CamelOperation">
100
120
<a name="CamelOperation"></a><h3>CamelOperation</h3>
101
121
<pre class="programlisting">typedef struct _CamelOperation CamelOperation;</pre>
106
<div class="refsect2" lang="en">
126
<div class="refsect2" title="CamelOperationStatusFunc ()">
107
127
<a name="CamelOperationStatusFunc"></a><h3>CamelOperationStatusFunc ()</h3>
108
128
<pre class="programlisting">void (*CamelOperationStatusFunc) (struct _CamelOperation *op,
111
gpointer data);</pre>
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>
114
140
<div class="variablelist"><table border="0">
152
<div class="refsect2" lang="en">
178
<div class="refsect2" title="camel_operation_new ()">
153
179
<a name="camel-operation-new"></a><h3>camel_operation_new ()</h3>
154
180
<pre class="programlisting"><a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> * camel_operation_new (<a class="link" href="camel-camel-operation.html#CamelOperationStatusFunc" title="CamelOperationStatusFunc ()">CamelOperationStatusFunc</a> status,
155
gpointer status_data);</pre>
182
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"
183
>gpointer</a> status_data);</pre>
157
185
Create a new camel operation handle. Camel operation handles can
158
186
be used in a multithreaded application (or a single operation
365
<div class="refsect2" lang="en">
393
<div class="refsect2" title="camel_operation_cancel_check ()">
366
394
<a name="camel-operation-cancel-check"></a><h3>camel_operation_cancel_check ()</h3>
367
<pre class="programlisting">gint camel_operation_cancel_check (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
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>
369
399
Check if cancellation has been applied to <em class="parameter"><code>cc</code></em>. If <em class="parameter"><code>cc</code></em> is NULL,
370
400
then the CamelOperation registered for the current thread is used.</p>
390
<div class="refsect2" lang="en">
420
<div class="refsect2" title="camel_operation_cancel_fd ()">
391
421
<a name="camel-operation-cancel-fd"></a><h3>camel_operation_cancel_fd ()</h3>
392
<pre class="programlisting">gint camel_operation_cancel_fd (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
422
<pre class="programlisting"><a
423
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"
424
>gint</a> camel_operation_cancel_fd (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
394
426
Retrieve a file descriptor that can be waited on (select, or poll)
395
427
for read, to asynchronously detect cancellation.</p>
450
482
<col align="left" valign="top">
452
484
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
453
<td> the registered operation, or <code class="literal">NULL</code> if none registered.
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.
459
<div class="refsect2" lang="en">
493
<div class="refsect2" title="camel_operation_start ()">
460
494
<a name="camel-operation-start"></a><h3>camel_operation_start ()</h3>
461
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"
465
501
Report the start of an operation. All start operations should have
524
<div class="refsect2" lang="en">
562
<div class="refsect2" title="camel_operation_progress ()">
525
563
<a name="camel-operation-progress"></a><h3>camel_operation_progress ()</h3>
526
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"
529
569
Report progress on the current operation. If <em class="parameter"><code>cc</code></em> is NULL, then the
530
570
currently registered operation is used. <em class="parameter"><code>pc</code></em> reports the current