/usr/share/gtk-doc/html/camel/camel-camel-mempool.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 | <!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-mempool</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-lock-client.html" title="camel-lock-client">
<link rel="next" href="camel-camel-mime-utils.html" title="camel-mime-utils">
<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-lock-client.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-mime-utils.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-mempool.synopsis" class="shortcut">Top</a>
|
<a href="#camel-camel-mempool.description" class="shortcut">Description</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="camel-camel-mempool.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool">CamelMemPool</a>;
enum <a class="link" href="camel-camel-mempool.html#CamelMemPoolFlags" title="enum CamelMemPoolFlags">CamelMemPoolFlags</a>;
<a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="returnvalue">CamelMemPool</span></a> * <a class="link" href="camel-camel-mempool.html#camel-mempool-new" title="camel_mempool_new ()">camel_mempool_new</a> (<em class="parameter"><code><span class="type">gint</span> blocksize</code></em>,
<em class="parameter"><code><span class="type">gint</span> 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>);
<span class="returnvalue">gpointer</span> <a class="link" href="camel-camel-mempool.html#camel-mempool-alloc" title="camel_mempool_alloc ()">camel_mempool_alloc</a> (<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><span class="type">gint</span> size</code></em>);
<span class="returnvalue">gchar</span> * <a class="link" href="camel-camel-mempool.html#camel-mempool-strdup" title="camel_mempool_strdup ()">camel_mempool_strdup</a> (<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 <span class="type">gchar</span> *str</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-mempool.html#camel-mempool-flush" title="camel_mempool_flush ()">camel_mempool_flush</a> (<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><span class="type">gint</span> freeall</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-mempool.html#camel-mempool-destroy" title="camel_mempool_destroy ()">camel_mempool_destroy</a> (<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>
</div>
<div class="refsect1">
<a name="camel-camel-mempool.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="camel-camel-mempool.details"></a><h2>Details</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>
<pre class="programlisting">typedef enum {
CAMEL_MEMPOOL_ALIGN_STRUCT,
CAMEL_MEMPOOL_ALIGN_WORD,
CAMEL_MEMPOOL_ALIGN_BYTE,
CAMEL_MEMPOOL_ALIGN_MASK = 0x3
} CamelMemPoolFlags;
</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="CAMEL-MEMPOOL-ALIGN-STRUCT:CAPS"></a><span class="term"><code class="literal">CAMEL_MEMPOOL_ALIGN_STRUCT</code></span></p></td>
<td>Allocate to native structure alignment
</td>
</tr>
<tr>
<td><p><a name="CAMEL-MEMPOOL-ALIGN-WORD:CAPS"></a><span class="term"><code class="literal">CAMEL_MEMPOOL_ALIGN_WORD</code></span></p></td>
<td>Allocate to words - 16 bit alignment
</td>
</tr>
<tr>
<td><p><a name="CAMEL-MEMPOOL-ALIGN-BYTE:CAPS"></a><span class="term"><code class="literal">CAMEL_MEMPOOL_ALIGN_BYTE</code></span></p></td>
<td>Allocate to bytes - 8 bit alignment
</td>
</tr>
<tr>
<td><p><a name="CAMEL-MEMPOOL-ALIGN-MASK:CAPS"></a><span class="term"><code class="literal">CAMEL_MEMPOOL_ALIGN_MASK</code></span></p></td>
<td>Which bits determine the alignment information
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
<hr>
<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><span class="type">gint</span> blocksize</code></em>,
<em class="parameter"><code><span class="type">gint</span> 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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>blocksize</code></em> :</span></p></td>
<td>The base blocksize to use for all system alocations.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>threshold</code></em> :</span></p></td>
<td>If the allocation exceeds the threshold, then it is
allocated separately and stored in a separate list.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
<td>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.</td>
</tr>
</tbody>
</table></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"><span class="returnvalue">gpointer</span> 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><span class="type">gint</span> 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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>pool</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="type">CamelMemPool</span></a>
</td>
</tr></tbody>
</table></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"><span class="returnvalue">gchar</span> * 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 <span class="type">gchar</span> *str</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>pool</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="type">CamelMemPool</span></a>
</td>
</tr></tbody>
</table></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><span class="type">gint</span> 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 <code class="literal">TRUE</code>, 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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pool</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="type">CamelMemPool</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>freeall</code></em> :</span></p></td>
<td>free all system allocated blocks as well</td>
</tr>
</tbody>
</table></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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>pool</code></em> :</span></p></td>
<td>a <a class="link" href="camel-camel-mempool.html#CamelMemPool" title="CamelMemPool"><span class="type">CamelMemPool</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 2.32</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|