/usr/share/gtk-doc/html/camel/camel-camel-uid-cache.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 | <!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-uid-cache</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-trie.html" title="camel-trie">
<link rel="next" href="camel-camel-url-scanner.html" title="camel-url-scanner">
<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-trie.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-url-scanner.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-uid-cache.synopsis" class="shortcut">Top</a>
|
<a href="#camel-camel-uid-cache.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="camel-camel-uid-cache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-camel-uid-cache.top_of_page"></a>camel-uid-cache</span></h2>
<p>camel-uid-cache</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="camel-camel-uid-cache.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="camel-camel-uid-cache.html#CamelUIDCache" title="CamelUIDCache">CamelUIDCache</a>;
<a class="link" href="camel-camel-uid-cache.html#CamelUIDCache" title="CamelUIDCache"><span class="returnvalue">CamelUIDCache</span></a> * <a class="link" href="camel-camel-uid-cache.html#camel-uid-cache-new" title="camel_uid_cache_new ()">camel_uid_cache_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="camel-camel-uid-cache.html#camel-uid-cache-save" title="camel_uid_cache_save ()">camel_uid_cache_save</a> (<em class="parameter"><code><a class="link" href="camel-camel-uid-cache.html#CamelUIDCache" title="CamelUIDCache"><span class="type">CamelUIDCache</span></a> *cache</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-uid-cache.html#camel-uid-cache-destroy" title="camel_uid_cache_destroy ()">camel_uid_cache_destroy</a> (<em class="parameter"><code><a class="link" href="camel-camel-uid-cache.html#CamelUIDCache" title="CamelUIDCache"><span class="type">CamelUIDCache</span></a> *cache</code></em>);
<span class="returnvalue">GPtrArray</span> * <a class="link" href="camel-camel-uid-cache.html#camel-uid-cache-get-new-uids" title="camel_uid_cache_get_new_uids ()">camel_uid_cache_get_new_uids</a> (<em class="parameter"><code><a class="link" href="camel-camel-uid-cache.html#CamelUIDCache" title="CamelUIDCache"><span class="type">CamelUIDCache</span></a> *cache</code></em>,
<em class="parameter"><code><span class="type">GPtrArray</span> *uids</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-uid-cache.html#camel-uid-cache-save-uid" title="camel_uid_cache_save_uid ()">camel_uid_cache_save_uid</a> (<em class="parameter"><code><a class="link" href="camel-camel-uid-cache.html#CamelUIDCache" title="CamelUIDCache"><span class="type">CamelUIDCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-uid-cache.html#camel-uid-cache-free-uids" title="camel_uid_cache_free_uids ()">camel_uid_cache_free_uids</a> (<em class="parameter"><code><span class="type">GPtrArray</span> *uids</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="camel-camel-uid-cache.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="camel-camel-uid-cache.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelUIDCache"></a><h3>CamelUIDCache</h3>
<pre class="programlisting">typedef struct {
gchar *filename;
GHashTable *uids;
guint level;
gsize expired;
gsize size;
gint fd;
} CamelUIDCache;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-uid-cache-new"></a><h3>camel_uid_cache_new ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-uid-cache.html#CamelUIDCache" title="CamelUIDCache"><span class="returnvalue">CamelUIDCache</span></a> * camel_uid_cache_new (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
<p>
Creates a new UID cache, initialized from <em class="parameter"><code>filename</code></em>. If <em class="parameter"><code>filename</code></em>
doesn't already exist, the UID cache will be empty. Otherwise, if
it does exist but can't be read, the function will return <code class="literal">NULL</code>.
</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 load the cache from</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new UID cache, or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-uid-cache-save"></a><h3>camel_uid_cache_save ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_uid_cache_save (<em class="parameter"><code><a class="link" href="camel-camel-uid-cache.html#CamelUIDCache" title="CamelUIDCache"><span class="type">CamelUIDCache</span></a> *cache</code></em>);</pre>
<p>
Attempts to save <em class="parameter"><code>cache</code></em> back 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>cache</code></em> :</span></p></td>
<td>a CamelUIDCache</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>success or failure</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-uid-cache-destroy"></a><h3>camel_uid_cache_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_uid_cache_destroy (<em class="parameter"><code><a class="link" href="camel-camel-uid-cache.html#CamelUIDCache" title="CamelUIDCache"><span class="type">CamelUIDCache</span></a> *cache</code></em>);</pre>
<p>
Destroys <em class="parameter"><code>cache</code></em> and frees its data.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>cache</code></em> :</span></p></td>
<td>a CamelUIDCache</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-uid-cache-get-new-uids"></a><h3>camel_uid_cache_get_new_uids ()</h3>
<pre class="programlisting"><span class="returnvalue">GPtrArray</span> * camel_uid_cache_get_new_uids (<em class="parameter"><code><a class="link" href="camel-camel-uid-cache.html#CamelUIDCache" title="CamelUIDCache"><span class="type">CamelUIDCache</span></a> *cache</code></em>,
<em class="parameter"><code><span class="type">GPtrArray</span> *uids</code></em>);</pre>
<p>
Returns an array of UIDs from <em class="parameter"><code>uids</code></em> that are not in <em class="parameter"><code>cache</code></em>, and
removes UIDs from <em class="parameter"><code>cache</code></em> that aren't in <em class="parameter"><code>uids</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>cache</code></em> :</span></p></td>
<td>a CamelUIDCache</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uids</code></em> :</span></p></td>
<td>an array of UIDs</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>an array of new UIDs, which must be freed with
<a class="link" href="camel-camel-uid-cache.html#camel-uid-cache-free-uids" title="camel_uid_cache_free_uids ()"><code class="function">camel_uid_cache_free_uids()</code></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-uid-cache-save-uid"></a><h3>camel_uid_cache_save_uid ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_uid_cache_save_uid (<em class="parameter"><code><a class="link" href="camel-camel-uid-cache.html#CamelUIDCache" title="CamelUIDCache"><span class="type">CamelUIDCache</span></a> *cache</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *uid</code></em>);</pre>
<p>
Marks a uid for saving.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>cache</code></em> :</span></p></td>
<td>a CamelUIDCache</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td>
<td>a uid to save</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-uid-cache-free-uids"></a><h3>camel_uid_cache_free_uids ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_uid_cache_free_uids (<em class="parameter"><code><span class="type">GPtrArray</span> *uids</code></em>);</pre>
<p>
Frees the array of UIDs.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>uids</code></em> :</span></p></td>
<td>an array returned from <a class="link" href="camel-camel-uid-cache.html#camel-uid-cache-get-new-uids" title="camel_uid_cache_get_new_uids ()"><code class="function">camel_uid_cache_get_new_uids()</code></a>
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|