/usr/share/gtk-doc/html/libebackend/libebackend-e-dbhash.html is in libebackend1.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 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>e-dbhash</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="prev" href="libebackend-EFileCache.html" title="EFileCache">
<link rel="next" href="libebackend-e-data-server-module.html" title="e-data-server-module">
<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="libebackend-EFileCache.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">Evolution-Data-Server Manual: Backend Utilities (libebackend)</th>
<td><a accesskey="n" href="libebackend-e-data-server-module.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libebackend-e-dbhash.synopsis" class="shortcut">Top</a>
|
<a href="#libebackend-e-dbhash.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libebackend-e-dbhash"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libebackend-e-dbhash.top_of_page"></a>e-dbhash</span></h2>
<p>e-dbhash — Simple DB-based hash table for strings</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libebackend-e-dbhash.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash">EDbHash</a>;
enum <a class="link" href="libebackend-e-dbhash.html#EDbHashStatus" title="enum EDbHashStatus">EDbHashStatus</a>;
<span class="returnvalue">void</span> (<a class="link" href="libebackend-e-dbhash.html#EDbHashFunc" title="EDbHashFunc ()">*EDbHashFunc</a>) (<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="returnvalue">EDbHash</span></a> * <a class="link" href="libebackend-e-dbhash.html#e-dbhash-new" title="e_dbhash_new ()">e_dbhash_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libebackend-e-dbhash.html#e-dbhash-add" title="e_dbhash_add ()">e_dbhash_add</a> (<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> *edbh</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libebackend-e-dbhash.html#e-dbhash-remove" title="e_dbhash_remove ()">e_dbhash_remove</a> (<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> *edbh</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);
<a class="link" href="libebackend-e-dbhash.html#EDbHashStatus" title="enum EDbHashStatus"><span class="returnvalue">EDbHashStatus</span></a> <a class="link" href="libebackend-e-dbhash.html#e-dbhash-compare" title="e_dbhash_compare ()">e_dbhash_compare</a> (<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> *edbh</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *compare_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libebackend-e-dbhash.html#e-dbhash-foreach-key" title="e_dbhash_foreach_key ()">e_dbhash_foreach_key</a> (<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> *edbh</code></em>,
<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHashFunc" title="EDbHashFunc ()"><span class="type">EDbHashFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libebackend-e-dbhash.html#e-dbhash-write" title="e_dbhash_write ()">e_dbhash_write</a> (<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> *edbh</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libebackend-e-dbhash.html#e-dbhash-destroy" title="e_dbhash_destroy ()">e_dbhash_destroy</a> (<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> *edbh</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libebackend-e-dbhash.description"></a><h2>Description</h2>
<p>
An <a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> is a simple hash table of strings backed by a Berkeley DB
file for permanent storage.
</p>
</div>
<div class="refsect1">
<a name="libebackend-e-dbhash.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="EDbHash"></a><h3>struct EDbHash</h3>
<pre class="programlisting">struct EDbHash {
EDbHashPrivate *priv;
};
</pre>
<p>
Contains only private data that should be read and manipulated using the
functions below.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="type">EDbHashPrivate</span> *<em class="structfield"><code><a name="EDbHash.priv"></a>priv</code></em>;</span></p></td>
<td>private data</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="EDbHashStatus"></a><h3>enum EDbHashStatus</h3>
<pre class="programlisting">typedef enum {
E_DBHASH_STATUS_SAME,
E_DBHASH_STATUS_DIFFERENT,
E_DBHASH_STATUS_NOT_FOUND
} EDbHashStatus;
</pre>
<p>
Return codes for <a class="link" href="libebackend-e-dbhash.html#e-dbhash-compare" title="e_dbhash_compare ()"><code class="function">e_dbhash_compare()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="E-DBHASH-STATUS-SAME:CAPS"></a><span class="term"><code class="literal">E_DBHASH_STATUS_SAME</code></span></p></td>
<td> The checksums match.
</td>
</tr>
<tr>
<td><p><a name="E-DBHASH-STATUS-DIFFERENT:CAPS"></a><span class="term"><code class="literal">E_DBHASH_STATUS_DIFFERENT</code></span></p></td>
<td> The checksums differ.
</td>
</tr>
<tr>
<td><p><a name="E-DBHASH-STATUS-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">E_DBHASH_STATUS_NOT_FOUND</code></span></p></td>
<td> The given key was not found.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="EDbHashFunc"></a><h3>EDbHashFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*EDbHashFunc) (<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
Callback function used in <a class="link" href="libebackend-e-dbhash.html#e-dbhash-foreach-key" title="e_dbhash_foreach_key ()"><code class="function">e_dbhash_foreach_key()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a database key</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data passed to <a class="link" href="libebackend-e-dbhash.html#e-dbhash-foreach-key" title="e_dbhash_foreach_key ()"><code class="function">e_dbhash_foreach_key()</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-dbhash-new"></a><h3>e_dbhash_new ()</h3>
<pre class="programlisting"><a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="returnvalue">EDbHash</span></a> * e_dbhash_new (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
<p>
Creates a new <a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> structure and opens the given Berkeley DB file,
creating the DB file if necessary.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>path to a Berkeley DB file</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-dbhash-add"></a><h3>e_dbhash_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_dbhash_add (<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> *edbh</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>);</pre>
<p>
Adds a database object for <em class="parameter"><code>key</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>edbh</code></em> :</span></p></td>
<td>an <a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a database key</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>a database object for <em class="parameter"><code>key</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-dbhash-remove"></a><h3>e_dbhash_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_dbhash_remove (<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> *edbh</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre>
<p>
Removes the database object corresponding to <em class="parameter"><code>key</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>edbh</code></em> :</span></p></td>
<td>an <a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a database key</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-dbhash-compare"></a><h3>e_dbhash_compare ()</h3>
<pre class="programlisting"><a class="link" href="libebackend-e-dbhash.html#EDbHashStatus" title="enum EDbHashStatus"><span class="returnvalue">EDbHashStatus</span></a> e_dbhash_compare (<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> *edbh</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *compare_data</code></em>);</pre>
<p>
Compares <em class="parameter"><code>compare_data</code></em> to the database object corresponding to
<em class="parameter"><code>key</code></em> using an MD5 checksum. Returns <a class="link" href="libebackend-e-dbhash.html#E-DBHASH-STATUS-SAME:CAPS"><span class="type">E_DBHASH_STATUS_SAME</span></a> if the
checksums match, <a class="link" href="libebackend-e-dbhash.html#E-DBHASH-STATUS-DIFFERENT:CAPS"><span class="type">E_DBHASH_STATUS_DIFFERENT</span></a> if the checksums differ,
or <a class="link" href="libebackend-e-dbhash.html#E-DBHASH-STATUS-NOT-FOUND:CAPS"><span class="type">E_DBHASH_STATUS_NOT_FOUND</span></a> if <em class="parameter"><code>key</code></em> is not present in the database.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>edbh</code></em> :</span></p></td>
<td>an <a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a database key</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>compare_data</code></em> :</span></p></td>
<td>data to compare against the database</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a checksum comparison status</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-dbhash-foreach-key"></a><h3>e_dbhash_foreach_key ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_dbhash_foreach_key (<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> *edbh</code></em>,
<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHashFunc" title="EDbHashFunc ()"><span class="type">EDbHashFunc</span></a> func</code></em>,
<em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
<p>
Calls <em class="parameter"><code>func</code></em> for each database object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>edbh</code></em> :</span></p></td>
<td>an <a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>a callback function</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>data to pass to <em class="parameter"><code>func</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-dbhash-write"></a><h3>e_dbhash_write ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_dbhash_write (<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> *edbh</code></em>);</pre>
<p>
Flushes database changes to disk.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>edbh</code></em> :</span></p></td>
<td>an <a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="e-dbhash-destroy"></a><h3>e_dbhash_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> e_dbhash_destroy (<em class="parameter"><code><a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a> *edbh</code></em>);</pre>
<p>
Closes the database file and frees the <a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>edbh</code></em> :</span></p></td>
<td>an <a class="link" href="libebackend-e-dbhash.html#EDbHash" title="struct EDbHash"><span class="type">EDbHash</span></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|