/usr/share/gtk-doc/html/camel/camel-camel-operation.html is in libcamel1.2-dev 3.2.3-0ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 | <!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.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Fundamentals.html" title="Fundamentals">
<link rel="prev" href="CamelObject.html" title="CamelObject">
<link rel="next" href="camel-camel-url.html" title="camel-url">
<meta name="generator" content="GTK-Doc V1.18 (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="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">
<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">
<a name="camel-camel-operation.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation">CamelOperation</a>;
<span class="returnvalue">GCancellable</span> * <a class="link" href="camel-camel-operation.html#camel-operation-new" title="camel_operation_new ()">camel_operation_new</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-cancel" title="camel_operation_cancel ()">camel_operation_cancel</a> (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a> *operation</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="struct CamelOperation"><span class="type">CamelOperation</span></a> *operation</code></em>);
<span class="returnvalue">gboolean</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="struct CamelOperation"><span class="type">CamelOperation</span></a> *operation</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="struct CamelOperation"><span class="type">CamelOperation</span></a> *operation</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="struct CamelOperation"><span class="type">CamelOperation</span></a> *operation</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-push-message" title="camel_operation_push_message ()">camel_operation_push_message</a> (<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
<em class="parameter"><code>...</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-operation.html#camel-operation-pop-message" title="camel_operation_pop_message ()">camel_operation_pop_message</a> (<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</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><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">gint</span> percent</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="camel-camel-operation.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="camel-camel-operation.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelOperation"></a><h3>struct CamelOperation</h3>
<pre class="programlisting">struct CamelOperation {
GCancellable parent;
CamelOperationPrivate *priv;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-operation-new"></a><h3>camel_operation_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GCancellable</span> * camel_operation_new (<em class="parameter"><code><span class="type">void</span></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"><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">
<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="struct CamelOperation"><span class="type">CamelOperation</span></a> *operation</code></em>);</pre>
<p>
Cancel a given operation. If <em class="parameter"><code>operation</code></em> is <code class="literal">NULL</code> 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>operation</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<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="struct CamelOperation"><span class="type">CamelOperation</span></a> *operation</code></em>);</pre>
<p>
Uncancel a cancelled operation.
</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>operation</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-operation-cancel-check"></a><h3>camel_operation_cancel_check ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_operation_cancel_check (<em class="parameter"><code><a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a> *operation</code></em>);</pre>
<p>
Check if cancellation has been applied to <em class="parameter"><code>operation</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>operation</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<code class="literal">TRUE</code> if the operation has been cancelled</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<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="struct CamelOperation"><span class="type">CamelOperation</span></a> *operation</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>operation</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a>
</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 has not been registered
for this thread.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<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="struct CamelOperation"><span class="type">CamelOperation</span></a> *operation</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>operation</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The fd, or <code class="literal">NULL</code> if cancellation has not been registered
for this thread.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-operation-push-message"></a><h3>camel_operation_push_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_push_message (<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *format</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Call this function to describe an operation being performed.
Call <a class="link" href="camel-camel-operation.html#camel-operation-progress" title="camel_operation_progress ()"><code class="function">camel_operation_progress()</code></a> to report progress on the operation.
Call <a class="link" href="camel-camel-operation.html#camel-operation-pop-message" title="camel_operation_pop_message ()"><code class="function">camel_operation_pop_message()</code></a> when the operation is complete.
</p>
<p>
This function only works if <em class="parameter"><code>cancellable</code></em> is a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a> cast as a
<span class="type">GCancellable</span>. If <em class="parameter"><code>cancellable</code></em> is a plain <span class="type">GCancellable</span> or <code class="literal">NULL</code>, the
function does nothing and returns silently.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>a <span class="type">GCancellable</span> or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>a standard <code class="function">printf()</code> format string</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-operation-pop-message"></a><h3>camel_operation_pop_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_operation_pop_message (<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>);</pre>
<p>
Pops the most recently pushed message.
</p>
<p>
This function only works if <em class="parameter"><code>cancellable</code></em> is a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a> cast as a
<span class="type">GCancellable</span>. If <em class="parameter"><code>cancellable</code></em> is a plain <span class="type">GCancellable</span> or <code class="literal">NULL</code>, the
function does nothing and returns silently.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>a <span class="type">GCancellable</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<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><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">gint</span> percent</code></em>);</pre>
<p>
Report progress on the current operation. <em class="parameter"><code>percent</code></em> reports the current
percentage of completion, which should be in the range of 0 to 100.
</p>
<p>
This function only works if <em class="parameter"><code>cancellable</code></em> is a <a class="link" href="camel-camel-operation.html#CamelOperation" title="struct CamelOperation"><span class="type">CamelOperation</span></a> cast as a
<span class="type">GCancellable</span>. If <em class="parameter"><code>cancellable</code></em> is a plain <span class="type">GCancellable</span> or <code class="literal">NULL</code>, the
function does nothing and returns silently.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>a <span class="type">GCancellable</span> or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>percent</code></em> :</span></p></td>
<td>percent complete, 0 to 100.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|