/usr/share/gtk-doc/html/camel/camel-camel-lock.html is in libcamel1.2-dev 3.2.3-0ubuntu7.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 | <!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-lock</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="Utilities.html" title="Utilities">
<link rel="prev" href="camel-camel-list-utils.html" title="camel-list-utils">
<link rel="next" href="camel-camel-lock-client.html" title="camel-lock-client">
<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="camel-camel-list-utils.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Utilities.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-lock-client.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-lock.synopsis" class="shortcut">Top</a>
|
<a href="#camel-camel-lock.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="camel-camel-lock"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-camel-lock.top_of_page"></a>camel-lock</span></h2>
<p>camel-lock</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="camel-camel-lock.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="camel-camel-lock.html#CAMEL-LOCK-DOT-RETRY:CAPS" title="CAMEL_LOCK_DOT_RETRY">CAMEL_LOCK_DOT_RETRY</a>
#define <a class="link" href="camel-camel-lock.html#CAMEL-LOCK-DOT-DELAY:CAPS" title="CAMEL_LOCK_DOT_DELAY">CAMEL_LOCK_DOT_DELAY</a>
#define <a class="link" href="camel-camel-lock.html#CAMEL-LOCK-DOT-STALE:CAPS" title="CAMEL_LOCK_DOT_STALE">CAMEL_LOCK_DOT_STALE</a>
#define <a class="link" href="camel-camel-lock.html#CAMEL-LOCK-RETRY:CAPS" title="CAMEL_LOCK_RETRY">CAMEL_LOCK_RETRY</a>
#define <a class="link" href="camel-camel-lock.html#CAMEL-LOCK-DELAY:CAPS" title="CAMEL_LOCK_DELAY">CAMEL_LOCK_DELAY</a>
enum <a class="link" href="camel-camel-lock.html#CamelLockType" title="enum CamelLockType">CamelLockType</a>;
<span class="returnvalue">gint</span> <a class="link" href="camel-camel-lock.html#camel-lock-dot" title="camel_lock_dot ()">camel_lock_dot</a> (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="camel-camel-lock.html#camel-lock-fcntl" title="camel_lock_fcntl ()">camel_lock_fcntl</a> (<em class="parameter"><code><span class="type">gint</span> fd</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-lock.html#CamelLockType" title="enum CamelLockType"><span class="type">CamelLockType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="camel-camel-lock.html#camel-lock-flock" title="camel_lock_flock ()">camel_lock_flock</a> (<em class="parameter"><code><span class="type">gint</span> fd</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-lock.html#CamelLockType" title="enum CamelLockType"><span class="type">CamelLockType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-lock.html#camel-unlock-dot" title="camel_unlock_dot ()">camel_unlock_dot</a> (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-lock.html#camel-unlock-fcntl" title="camel_unlock_fcntl ()">camel_unlock_fcntl</a> (<em class="parameter"><code><span class="type">gint</span> fd</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-lock.html#camel-unlock-flock" title="camel_unlock_flock ()">camel_unlock_flock</a> (<em class="parameter"><code><span class="type">gint</span> fd</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="camel-camel-lock.html#camel-lock-folder" title="camel_lock_folder ()">camel_lock_folder</a> (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> fd</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-lock.html#CamelLockType" title="enum CamelLockType"><span class="type">CamelLockType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-lock.html#camel-unlock-folder" title="camel_unlock_folder ()">camel_unlock_folder</a> (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> fd</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="camel-camel-lock.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="camel-camel-lock.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CAMEL-LOCK-DOT-RETRY:CAPS"></a><h3>CAMEL_LOCK_DOT_RETRY</h3>
<pre class="programlisting">#define CAMEL_LOCK_DOT_RETRY (5) /* number of times to retry lock */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-LOCK-DOT-DELAY:CAPS"></a><h3>CAMEL_LOCK_DOT_DELAY</h3>
<pre class="programlisting">#define CAMEL_LOCK_DOT_DELAY (2) /* delay between locking retries */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-LOCK-DOT-STALE:CAPS"></a><h3>CAMEL_LOCK_DOT_STALE</h3>
<pre class="programlisting">#define CAMEL_LOCK_DOT_STALE (60) /* seconds before a lock becomes stale */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-LOCK-RETRY:CAPS"></a><h3>CAMEL_LOCK_RETRY</h3>
<pre class="programlisting">#define CAMEL_LOCK_RETRY (5) /* number of times to retry lock */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-LOCK-DELAY:CAPS"></a><h3>CAMEL_LOCK_DELAY</h3>
<pre class="programlisting">#define CAMEL_LOCK_DELAY (2) /* delay between locking retries */
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelLockType"></a><h3>enum CamelLockType</h3>
<pre class="programlisting">typedef enum {
CAMEL_LOCK_READ,
CAMEL_LOCK_WRITE
} CamelLockType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-lock-dot"></a><h3>camel_lock_dot ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_lock_dot (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Create an exclusive lock using .lock semantics.
All locks are equivalent to write locks (exclusive).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>-1 on error, sets <em class="parameter"><code>ex</code></em> appropriately.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-lock-fcntl"></a><h3>camel_lock_fcntl ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_lock_fcntl (<em class="parameter"><code><span class="type">gint</span> fd</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-lock.html#CamelLockType" title="enum CamelLockType"><span class="type">CamelLockType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Create a lock using fcntl(2).
</p>
<p>
<em class="parameter"><code>type</code></em> is CAMEL_LOCK_WRITE or CAMEL_LOCK_READ,
to create exclusive or shared read locks
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>-1 on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-lock-flock"></a><h3>camel_lock_flock ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_lock_flock (<em class="parameter"><code><span class="type">gint</span> fd</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-lock.html#CamelLockType" title="enum CamelLockType"><span class="type">CamelLockType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Create a lock using flock(2).
</p>
<p>
<em class="parameter"><code>type</code></em> is CAMEL_LOCK_WRITE or CAMEL_LOCK_READ,
to create exclusive or shared read locks
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>-1 on error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-unlock-dot"></a><h3>camel_unlock_dot ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_unlock_dot (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>);</pre>
<p>
Attempt to unlock a .lock lock.
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-unlock-fcntl"></a><h3>camel_unlock_fcntl ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_unlock_fcntl (<em class="parameter"><code><span class="type">gint</span> fd</code></em>);</pre>
<p>
Unlock an fcntl lock.
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-unlock-flock"></a><h3>camel_unlock_flock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_unlock_flock (<em class="parameter"><code><span class="type">gint</span> fd</code></em>);</pre>
<p>
Unlock an flock lock.
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-lock-folder"></a><h3>camel_lock_folder ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_lock_folder (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> fd</code></em>,
<em class="parameter"><code><a class="link" href="camel-camel-lock.html#CamelLockType" title="enum CamelLockType"><span class="type">CamelLockType</span></a> type</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Attempt to lock a folder, multiple attempts will be made using all
locking strategies available.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>Path to the file to lock (used for .locking only).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
<td>Open file descriptor of the right type to lock.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>Type of lock, CAMEL_LOCK_READ or CAMEL_LOCK_WRITE.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>-1 on error, <em class="parameter"><code>ex</code></em> will describe the locking system that failed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-unlock-folder"></a><h3>camel_unlock_folder ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_unlock_folder (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
<em class="parameter"><code><span class="type">gint</span> fd</code></em>);</pre>
<p>
Free a lock on a folder.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>Filename of folder.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
<td>Open descrptor on which locks were placed.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|