This file is indexed.

/usr/share/gtk-doc/html/camel/camel-camel-mempool.html is in evolution-data-server-doc 3.10.4-0ubuntu1.6.

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
<!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 Reference Manual: camel-mempool</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.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-memchunk.html" title="camel-memchunk">
<link rel="next" href="camel-camel-mime-utils.html" title="camel-mime-utils">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><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="#camel-camel-mempool.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#camel-camel-mempool.object-hierarchy" class="shortcut">Object Hierarchy</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="Utilities.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="camel-camel-memchunk.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="camel-camel-mime-utils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="camel-camel-mempool"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-camel-mempool.top_of_page"></a>camel-mempool</span></h2>
<p>camel-mempool</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="camel-camel-mempool.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="returnvalue">CamelMemPool</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-camel-mempool.html#camel-mempool-new" title="camel_mempool_new ()">camel_mempool_new</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#gpointer"><span class="returnvalue">gpointer</span></a>
</td>
<td class="function_name">
<a class="link" href="camel-camel-mempool.html#camel-mempool-alloc" title="camel_mempool_alloc ()">camel_mempool_alloc</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#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="camel-camel-mempool.html#camel-mempool-strdup" title="camel_mempool_strdup ()">camel_mempool_strdup</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="camel-camel-mempool.html#camel-mempool-flush" title="camel_mempool_flush ()">camel_mempool_flush</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="camel-camel-mempool.html#camel-mempool-destroy" title="camel_mempool_destroy ()">camel_mempool_destroy</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="camel-camel-mempool.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool">CamelMemPool</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="camel-camel-mempool.html#CamelMemPoolFlags" title="enum CamelMemPoolFlags">CamelMemPoolFlags</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="camel-camel-mempool.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">
</pre>
</div>
<div class="refsect1">
<a name="camel-camel-mempool.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="camel-camel-mempool.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="camel-mempool-new"></a><h3>camel_mempool_new ()</h3>
<pre class="programlisting"><a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="returnvalue">CamelMemPool</span></a> *
camel_mempool_new (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> blocksize</code></em>,
                   <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> threshold</code></em>,
                   <em class="parameter"><code><a class="link" href="camel-camel-mempool.html#CamelMemPoolFlags" title="enum CamelMemPoolFlags"><span class="type">CamelMemPoolFlags</span></a> flags</code></em>);</pre>
<p>Create a new mempool header.  Mempools can be used to efficiently
allocate data which can then be freed as a whole.</p>
<p>Mempools can also be used to efficiently allocate arbitrarily
aligned data (such as strings) without incurring the space overhead
of aligning each allocation (which is not required for strings).</p>
<p>However, each allocation cannot be freed individually, only all
or nothing.</p>
<div class="refsect3">
<a name="id-1.2.14.8.7.2.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>blocksize</p></td>
<td class="parameter_description"><p>The base blocksize to use for all system alocations.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>threshold</p></td>
<td class="parameter_description"><p>If the allocation exceeds the threshold, then it is
allocated separately and stored in a separate list.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>Alignment options: CAMEL_MEMPOOL_ALIGN_STRUCT uses native
struct alignment, CAMEL_MEMPOOL_ALIGN_WORD aligns to 16 bits (2 bytes),
and CAMEL_MEMPOOL_ALIGN_BYTE aligns to the nearest byte.  The default
is to align to native structures.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.14.8.7.2.8"></a><h4>Returns</h4>
<p></p>
</div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mempool-alloc"></a><h3>camel_mempool_alloc ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
camel_mempool_alloc (<em class="parameter"><code><a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="type">CamelMemPool</span></a> *pool</code></em>,
                     <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> size</code></em>);</pre>
<p>Allocate a new data block in the mempool.  Size will
be rounded up to the mempool's alignment restrictions
before being used.</p>
<div class="refsect3">
<a name="id-1.2.14.8.7.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>pool</p></td>
<td class="parameter_description"><p>a <a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="type">CamelMemPool</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mempool-strdup"></a><h3>camel_mempool_strdup ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
camel_mempool_strdup (<em class="parameter"><code><a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="type">CamelMemPool</span></a> *pool</code></em>,
                      <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *str</code></em>);</pre>
<div class="refsect3">
<a name="id-1.2.14.8.7.4.4"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>pool</p></td>
<td class="parameter_description"><p>a <a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="type">CamelMemPool</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mempool-flush"></a><h3>camel_mempool_flush ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_mempool_flush (<em class="parameter"><code><a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="type">CamelMemPool</span></a> *pool</code></em>,
                     <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> freeall</code></em>);</pre>
<p>Flush used memory and mark allocated blocks as free.</p>
<p>If <em class="parameter"><code>freeall</code></em>
 is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, then all allocated blocks are free'd
as well.  Otherwise only blocks above the threshold are
actually freed, and the others are simply marked as empty.</p>
<div class="refsect3">
<a name="id-1.2.14.8.7.5.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>pool</p></td>
<td class="parameter_description"><p>a <a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="type">CamelMemPool</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>freeall</p></td>
<td class="parameter_description"><p>free all system allocated blocks as well</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-mempool-destroy"></a><h3>camel_mempool_destroy ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
camel_mempool_destroy (<em class="parameter"><code><a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="type">CamelMemPool</span></a> *pool</code></em>);</pre>
<p>Free all memory associated with a mempool.</p>
<div class="refsect3">
<a name="id-1.2.14.8.7.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>pool</p></td>
<td class="parameter_description"><p>a <a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="type">CamelMemPool</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since 2.32</p>
</div>
</div>
<div class="refsect1">
<a name="camel-camel-mempool.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="CamelMemPool"></a><h3>CamelMemPool</h3>
<pre class="programlisting">typedef struct _CamelMemPool CamelMemPool;</pre>
<p class="since">Since 2.32</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelMemPoolFlags"></a><h3>enum CamelMemPoolFlags</h3>
<div class="refsect3">
<a name="id-1.2.14.8.8.3.3"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="CAMEL-MEMPOOL-ALIGN-STRUCT:CAPS"></a>CAMEL_MEMPOOL_ALIGN_STRUCT</p></td>
<td class="enum_member_description">
<p>Allocate to native structure alignment</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CAMEL-MEMPOOL-ALIGN-WORD:CAPS"></a>CAMEL_MEMPOOL_ALIGN_WORD</p></td>
<td class="enum_member_description">
<p>Allocate to words - 16 bit alignment</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CAMEL-MEMPOOL-ALIGN-BYTE:CAPS"></a>CAMEL_MEMPOOL_ALIGN_BYTE</p></td>
<td class="enum_member_description">
<p>Allocate to bytes - 8 bit alignment</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="CAMEL-MEMPOOL-ALIGN-MASK:CAPS"></a>CAMEL_MEMPOOL_ALIGN_MASK</p></td>
<td class="enum_member_description">
<p>Which bits determine the alignment information</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 2.32</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>