| Server IP : 182.53.201.61 / Your IP : 216.73.217.175 Web Server : Apache/2.2.15 (Fedora) System : Linux km10.dyndns.org 2.6.31.5-127.fc12.i686.PAE #1 SMP Sat Nov 7 21:25:57 EST 2009 i686 User : apache ( 48) PHP Version : 5.3.3 Disable Function : NONE MySQL : ON | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /usr/share/gtk-doc/html/camel/ |
Upload File : |
<!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.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="classes.html" title="Part I. Camel Classes">
<link rel="chapter" href="ClassTree.html" title="Class Hierarchy">
<link rel="chapter" href="Fundamentals.html" title="Fundamentals">
<link rel="chapter" href="Streams.html" title="Streams">
<link rel="chapter" href="StreamFilters.html" title="Stream Filters">
<link rel="chapter" href="Services.html" title="Services">
<link rel="chapter" href="Filters.html" title="Filters">
<link rel="chapter" href="Folders.html" title="Folders">
<link rel="chapter" href="SearchFolders.html" title="Search Folders">
<link rel="chapter" href="Addresses.html" title="Addresses">
<link rel="chapter" href="Crypto.html" title="Crypto Contexts">
<link rel="chapter" href="MIME.html" title="MIME Objects">
<link rel="chapter" href="Storage.html" title="Metadata Storage">
<link rel="chapter" href="Utilities.html" title="Utilities">
<link rel="chapter" href="Deprecated.html" title="Deprecated Objects">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
</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>;
void (<a class="link" href="camel-camel-operation.html#CamelOperationStatusFunc" title="CamelOperationStatusFunc ()">*CamelOperationStatusFunc</a>) (struct _CamelOperation *op,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *what,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> pc,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);
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">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,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> status_data);
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);
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);
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);
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);
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);
<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);
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);
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);
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);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>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);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>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);
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);
<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);
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,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *what,
...);
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,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *what,
...);
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,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> pc);
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,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> sofar);
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);
</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">void (*CamelOperationStatusFunc) (struct _CamelOperation *op,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *what,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> pc,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> data);</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">CamelOperation</a> * camel_operation_new (<a class="link" href="camel-camel-operation.html#CamelOperationStatusFunc" title="CamelOperationStatusFunc ()">CamelOperationStatusFunc</a> status,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"
>gpointer</a> status_data);</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>
<p>
</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">void camel_operation_mute (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
<p>
mutes a camel operation permanently. from this point on you will never
receive operation updates, even if more are sent.</p>
<p>
</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>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="camel_operation_ref ()">
<a name="camel-operation-ref"></a><h3>camel_operation_ref ()</h3>
<pre class="programlisting">void camel_operation_ref (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
<p>
Add a reference to the CamelOperation <em class="parameter"><code>cc</code></em>.</p>
<p>
</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">void camel_operation_unref (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
<p>
Unref and potentially free <em class="parameter"><code>cc</code></em>.</p>
<p>
</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">void camel_operation_cancel (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
<p>
Cancel a given operation. If <em class="parameter"><code>cc</code></em> is NULL then all outstanding
operations are cancelled.</p>
<p>
</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">void camel_operation_uncancel (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</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>
<p>
</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">CamelOperation</a> * camel_operation_register (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</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>
<p>
</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">void camel_operation_unregister (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
<p>
Unregister the current thread for all cancellations.</p>
<p>
</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">void camel_operation_cancel_block (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
<p>
Block cancellation for this operation. If <em class="parameter"><code>cc</code></em> is NULL, then the
current thread is blocked.</p>
<p>
</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">void camel_operation_cancel_unblock (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</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>
<p>
</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"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> camel_operation_cancel_check (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</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>
<p>
</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"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> camel_operation_cancel_fd (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
<p>
Retrieve a file descriptor that can be waited on (select, or poll)
for read, to asynchronously detect cancellation.</p>
<p>
</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 PRFileDesc * camel_operation_cancel_prfd (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</pre>
<p>
Retrieve a file descriptor that can be waited on (select, or poll)
for read, to asynchronously detect cancellation.</p>
<p>
</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">CamelOperation</a> * camel_operation_registered (void);</pre>
<p>
</p>
<p>
</p>
<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 <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL--CAPS"
><code class="literal">NULL</code></a> 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">void camel_operation_start (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *what,
...);</pre>
<p>
Report the start of an operation. All start operations should have
similar end operations.</p>
<p>
</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">void camel_operation_start_transient (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *what,
...);</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>
<p>
</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">void camel_operation_progress (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> pc);</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>
<p>
</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">void camel_operation_progress_count (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc,
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> sofar);</pre>
<p>
</p>
<p>
</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>sofar</code></em> :</span></p></td>
<td>
</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">void camel_operation_end (<a class="link" href="camel-camel-operation.html#CamelOperation" title="CamelOperation">CamelOperation</a> *cc);</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>
<p>
</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.11</div>
</body>
</html>