/usr/share/gtk-doc/html/eds/eds-Cancellable-Locks.html is in evolution-data-server-doc 3.22.7-1.
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 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Cancellable Locks: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch10.html" title="Available for clients and backends">
<link rel="prev" href="eds-e-categories.html" title="e-categories">
<link rel="next" href="eds-e-cache-reaper.html" title="e-cache-reaper">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#eds-Cancellable-Locks.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch10.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="eds-e-categories.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="eds-e-cache-reaper.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-Cancellable-Locks"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-Cancellable-Locks.top_of_page"></a>Cancellable Locks</span></h2>
<p>Cancellable Locks — locks, which can listen for a <a href="/usr/share/gtk-doc/html/gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> during lock call</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-Cancellable-Locks.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-Cancellable-Locks.html#e-cancellable-mutex-init" title="e_cancellable_mutex_init ()">e_cancellable_mutex_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-Cancellable-Locks.html#e-cancellable-mutex-clear" title="e_cancellable_mutex_clear ()">e_cancellable_mutex_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-Cancellable-Locks.html#e-cancellable-mutex-lock" title="e_cancellable_mutex_lock ()">e_cancellable_mutex_lock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-Cancellable-Locks.html#e-cancellable-mutex-unlock" title="e_cancellable_mutex_unlock ()">e_cancellable_mutex_unlock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GMutex"><span class="returnvalue">GMutex</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-Cancellable-Locks.html#e-cancellable-mutex-get-internal-mutex" title="e_cancellable_mutex_get_internal_mutex ()">e_cancellable_mutex_get_internal_mutex</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-Cancellable-Locks.html#e-cancellable-rec-mutex-init" title="e_cancellable_rec_mutex_init ()">e_cancellable_rec_mutex_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-Cancellable-Locks.html#e-cancellable-rec-mutex-clear" title="e_cancellable_rec_mutex_clear ()">e_cancellable_rec_mutex_clear</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-Cancellable-Locks.html#e-cancellable-rec-mutex-lock" title="e_cancellable_rec_mutex_lock ()">e_cancellable_rec_mutex_lock</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-Cancellable-Locks.html#e-cancellable-rec-mutex-unlock" title="e_cancellable_rec_mutex_unlock ()">e_cancellable_rec_mutex_unlock</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-Cancellable-Locks.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-Cancellable-Locks.html#ECancellableLocksBase" title="struct ECancellableLocksBase">ECancellableLocksBase</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-Cancellable-Locks.html#ECancellableMutex" title="struct ECancellableMutex">ECancellableMutex</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-Cancellable-Locks.html#ECancellableRecMutex" title="struct ECancellableRecMutex">ECancellableRecMutex</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-Cancellable-Locks.description"></a><h2>Description</h2>
<p>An <a class="link" href="eds-Cancellable-Locks.html#ECancellableMutex" title="struct ECancellableMutex"><span class="type">ECancellableMutex</span></a> and an <a class="link" href="eds-Cancellable-Locks.html#ECancellableRecMutex" title="struct ECancellableRecMutex"><span class="type">ECancellableRecMutex</span></a> are similar to
GLib's <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GMutex"><span class="type">GMutex</span></a> and <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GRecMutex"><span class="type">GRecMutex</span></a>, with one exception, their <span style="color: red"><i>lock</i></span>
function takes also a <em class="parameter"><code>GCancellable</code></em>
instance, thus the waiting for a lock
can be cancelled any time.</p>
</div>
<div class="refsect1">
<a name="eds-Cancellable-Locks.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-cancellable-mutex-init"></a><h3>e_cancellable_mutex_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_cancellable_mutex_init (<em class="parameter"><code><a class="link" href="eds-Cancellable-Locks.html#ECancellableMutex" title="struct ECancellableMutex"><span class="type">ECancellableMutex</span></a> *mutex</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_cancellable_mutex_init</code> has been deprecated since version 3.12 and should not be used in newly-written code.</p>
<p>If you think you need this, you're using mutexes wrong.</p>
</div>
<p>Initializes <em class="parameter"><code>mutex</code></em>
structure.</p>
<div class="refsect3">
<a name="e-cancellable-mutex-init.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mutex</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-Cancellable-Locks.html#ECancellableMutex" title="struct ECancellableMutex"><span class="type">ECancellableMutex</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cancellable-mutex-clear"></a><h3>e_cancellable_mutex_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_cancellable_mutex_clear (<em class="parameter"><code><a class="link" href="eds-Cancellable-Locks.html#ECancellableMutex" title="struct ECancellableMutex"><span class="type">ECancellableMutex</span></a> *mutex</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_cancellable_mutex_clear</code> has been deprecated since version 3.12 and should not be used in newly-written code.</p>
<p>If you think you need this, you're using mutexes wrong.</p>
</div>
<p>Frees memory allocated by <a class="link" href="eds-Cancellable-Locks.html#e-cancellable-mutex-init" title="e_cancellable_mutex_init ()"><code class="function">e_cancellable_mutex_init()</code></a>.</p>
<div class="refsect3">
<a name="e-cancellable-mutex-clear.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mutex</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-Cancellable-Locks.html#ECancellableMutex" title="struct ECancellableMutex"><span class="type">ECancellableMutex</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cancellable-mutex-lock"></a><h3>e_cancellable_mutex_lock ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_cancellable_mutex_lock (<em class="parameter"><code><a class="link" href="eds-Cancellable-Locks.html#ECancellableMutex" title="struct ECancellableMutex"><span class="type">ECancellableMutex</span></a> *mutex</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_cancellable_mutex_lock</code> has been deprecated since version 3.12 and should not be used in newly-written code.</p>
<p>If you think you need this, you're using mutexes wrong.</p>
</div>
<p>Acquires lock on <em class="parameter"><code>mutex</code></em>
. The returned value indicates whether
the lock was acquired, while <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned only either or
invalid arguments or the passed in <em class="parameter"><code>cancellable</code></em>
had been cancelled.
In case of <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>cancellable</code></em>
the function blocks like <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#g-mutex-lock"><code class="function">g_mutex_lock()</code></a>.</p>
<div class="refsect3">
<a name="e-cancellable-mutex-lock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>mutex</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-Cancellable-Locks.html#ECancellableMutex" title="struct ECancellableMutex"><span class="type">ECancellableMutex</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cancellable-mutex-lock.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if lock had been acquired, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cancellable-mutex-unlock"></a><h3>e_cancellable_mutex_unlock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_cancellable_mutex_unlock (<em class="parameter"><code><a class="link" href="eds-Cancellable-Locks.html#ECancellableMutex" title="struct ECancellableMutex"><span class="type">ECancellableMutex</span></a> *mutex</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_cancellable_mutex_unlock</code> has been deprecated since version 3.12 and should not be used in newly-written code.</p>
<p>If you think you need this, you're using mutexes wrong.</p>
</div>
<p>Releases lock previously acquired by <a class="link" href="eds-Cancellable-Locks.html#e-cancellable-mutex-lock" title="e_cancellable_mutex_lock ()"><code class="function">e_cancellable_mutex_lock()</code></a>.
Behaviour is undefined if this is called on a <em class="parameter"><code>mutex</code></em>
which returned
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> in <a class="link" href="eds-Cancellable-Locks.html#e-cancellable-mutex-lock" title="e_cancellable_mutex_lock ()"><code class="function">e_cancellable_mutex_lock()</code></a>.</p>
<div class="refsect3">
<a name="e-cancellable-mutex-unlock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mutex</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-Cancellable-Locks.html#ECancellableMutex" title="struct ECancellableMutex"><span class="type">ECancellableMutex</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cancellable-mutex-get-internal-mutex"></a><h3>e_cancellable_mutex_get_internal_mutex ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GMutex"><span class="returnvalue">GMutex</span></a> *
e_cancellable_mutex_get_internal_mutex
(<em class="parameter"><code><a class="link" href="eds-Cancellable-Locks.html#ECancellableMutex" title="struct ECancellableMutex"><span class="type">ECancellableMutex</span></a> *mutex</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_cancellable_mutex_get_internal_mutex</code> has been deprecated since version 3.12 and should not be used in newly-written code.</p>
<p>If you think you need this, you're using mutexes wrong.</p>
</div>
<p>To get internal <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GMutex"><span class="type">GMutex</span></a>. This is meant for cases when a lock is already
acquired, and the caller needs to wait for a <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GCond"><span class="type">GCond</span></a>, in which case
the returned <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GMutex"><span class="type">GMutex</span></a> can be used to <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#g-cond-wait"><code class="function">g_cond_wait()</code></a> or <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#g-cond-wait-until"><code class="function">g_cond_wait_until()</code></a>.</p>
<div class="refsect3">
<a name="e-cancellable-mutex-get-internal-mutex.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>mutex</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-Cancellable-Locks.html#ECancellableMutex" title="struct ECancellableMutex"><span class="type">ECancellableMutex</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cancellable-mutex-get-internal-mutex.returns"></a><h4>Returns</h4>
<p> Internal <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#GMutex"><span class="type">GMutex</span></a>, used in <em class="parameter"><code>mutex</code></em>
</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cancellable-rec-mutex-init"></a><h3>e_cancellable_rec_mutex_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_cancellable_rec_mutex_init (<em class="parameter"><code><a class="link" href="eds-Cancellable-Locks.html#ECancellableRecMutex" title="struct ECancellableRecMutex"><span class="type">ECancellableRecMutex</span></a> *rec_mutex</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_cancellable_rec_mutex_init</code> has been deprecated since version 3.12 and should not be used in newly-written code.</p>
<p>If you think you need this, you're using mutexes wrong.</p>
</div>
<p>Initializes <em class="parameter"><code>rec_mutex</code></em>
structure.</p>
<div class="refsect3">
<a name="e-cancellable-rec-mutex-init.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>rec_mutex</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-Cancellable-Locks.html#ECancellableRecMutex" title="struct ECancellableRecMutex"><span class="type">ECancellableRecMutex</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cancellable-rec-mutex-clear"></a><h3>e_cancellable_rec_mutex_clear ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_cancellable_rec_mutex_clear (<em class="parameter"><code><a class="link" href="eds-Cancellable-Locks.html#ECancellableRecMutex" title="struct ECancellableRecMutex"><span class="type">ECancellableRecMutex</span></a> *rec_mutex</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_cancellable_rec_mutex_clear</code> has been deprecated since version 3.12 and should not be used in newly-written code.</p>
<p>If you think you need this, you're using mutexes wrong.</p>
</div>
<p>Frees memory allocated by <a class="link" href="eds-Cancellable-Locks.html#e-cancellable-rec-mutex-init" title="e_cancellable_rec_mutex_init ()"><code class="function">e_cancellable_rec_mutex_init()</code></a>.</p>
<div class="refsect3">
<a name="e-cancellable-rec-mutex-clear.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>rec_mutex</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-Cancellable-Locks.html#ECancellableRecMutex" title="struct ECancellableRecMutex"><span class="type">ECancellableRecMutex</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cancellable-rec-mutex-lock"></a><h3>e_cancellable_rec_mutex_lock ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_cancellable_rec_mutex_lock (<em class="parameter"><code><a class="link" href="eds-Cancellable-Locks.html#ECancellableRecMutex" title="struct ECancellableRecMutex"><span class="type">ECancellableRecMutex</span></a> *rec_mutex</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_cancellable_rec_mutex_lock</code> has been deprecated since version 3.12 and should not be used in newly-written code.</p>
<p>If you think you need this, you're using mutexes wrong.</p>
</div>
<p>Acquires lock on <em class="parameter"><code>rec_mutex</code></em>
. The returned value indicates whether
the lock was acquired, while <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned only either or
invalid arguments or the passed in <em class="parameter"><code>cancellable</code></em>
had been cancelled.
In case of <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> <em class="parameter"><code>cancellable</code></em>
the function blocks like <a href="/usr/share/gtk-doc/html/glib/glib-Threads.html#g-rec-mutex-lock"><code class="function">g_rec_mutex_lock()</code></a>.</p>
<div class="refsect3">
<a name="e-cancellable-rec-mutex-lock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>rec_mutex</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-Cancellable-Locks.html#ECancellableRecMutex" title="struct ECancellableRecMutex"><span class="type">ECancellableRecMutex</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-cancellable-rec-mutex-lock.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, if lock had been acquired, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-cancellable-rec-mutex-unlock"></a><h3>e_cancellable_rec_mutex_unlock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_cancellable_rec_mutex_unlock (<em class="parameter"><code><a class="link" href="eds-Cancellable-Locks.html#ECancellableRecMutex" title="struct ECancellableRecMutex"><span class="type">ECancellableRecMutex</span></a> *rec_mutex</code></em>);</pre>
<div class="warning">
<p><code class="literal">e_cancellable_rec_mutex_unlock</code> has been deprecated since version 3.12 and should not be used in newly-written code.</p>
<p>If you think you need this, you're using mutexes wrong.</p>
</div>
<p>Releases lock previously acquired by <a class="link" href="eds-Cancellable-Locks.html#e-cancellable-rec-mutex-lock" title="e_cancellable_rec_mutex_lock ()"><code class="function">e_cancellable_rec_mutex_lock()</code></a>.
Behaviour is undefined if this is called on a <em class="parameter"><code>rec_mutex</code></em>
which returned
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> in <a class="link" href="eds-Cancellable-Locks.html#e-cancellable-rec-mutex-lock" title="e_cancellable_rec_mutex_lock ()"><code class="function">e_cancellable_rec_mutex_lock()</code></a>.</p>
<div class="refsect3">
<a name="e-cancellable-rec-mutex-unlock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>rec_mutex</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-Cancellable-Locks.html#ECancellableRecMutex" title="struct ECancellableRecMutex"><span class="type">ECancellableRecMutex</span></a> instance</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.8.html" title="Index of new symbols in 3.8">3.8</a></p>
</div>
</div>
<div class="refsect1">
<a name="eds-Cancellable-Locks.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ECancellableLocksBase"></a><h3>struct ECancellableLocksBase</h3>
<pre class="programlisting">struct ECancellableLocksBase {
GMutex cond_mutex;
GCond cond;
};
</pre>
<div class="warning"><p><code class="literal">ECancellableLocksBase</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="ECancellableMutex"></a><h3>struct ECancellableMutex</h3>
<pre class="programlisting">struct ECancellableMutex {
struct _ECancellableLocksBase base;
GMutex mutex;
};
</pre>
<div class="warning"><p><code class="literal">ECancellableMutex</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
<hr>
<div class="refsect2">
<a name="ECancellableRecMutex"></a><h3>struct ECancellableRecMutex</h3>
<pre class="programlisting">struct ECancellableRecMutex {
struct _ECancellableLocksBase base;
GRecMutex rec_mutex;
};
</pre>
<div class="warning"><p><code class="literal">ECancellableRecMutex</code> is deprecated and should not be used in newly-written code.</p></div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|