<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Apache Portable Runtime: apr_pools.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<h1>apr_pools.h File Reference</h1>APR memory allocation. <a href="#_details">More...</a>
<p>
<code>#include "<a class="el" href="apr_8h-source.html">apr.h</a>"</code><br>
<code>#include "<a class="el" href="apr__errno_8h-source.html">apr_errno.h</a>"</code><br>
<code>#include "<a class="el" href="apr__general_8h-source.html">apr_general.h</a>"</code><br>
<code>#include "<a class="el" href="apr__want_8h-source.html">apr_want.h</a>"</code><br>
<code>#include "<a class="el" href="apr__allocator_8h-source.html">apr_allocator.h</a>"</code><br>
<p>
<a href="apr__pools_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apr__pools_8h.html#b8737b3e89f7da73a0d8d89e75a2e856">APR_WANT_MEMFUNC</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g6dda96940d296b27a1bc98d9f49735e4">APR_POOL_DECLARE_ACCESSOR</a>(type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gcb2aed20b9b3a590e4844c77dbedf5dd">APR_POOL_IMPLEMENT_ACCESSOR</a>(type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g2519c778a4278b46de35fa77a0ade11c">APR_POOL_DEBUG</a> 0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g9fe1615522ad68e36a595f65626029fe">APR_POOL__FILE_LINE__</a> __FILE__ ":" APR_STRINGIFY(__LINE__)</td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef int(*) </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga49969ddb0e43ef8f7053de6cec11986">apr_abortfunc_t</a> (int retcode)</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g577d2bfd13af9cdd02659b3b8e994723">apr_pool_initialize</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gbc12d7540010ba393c8ca7ac0941a4a4">apr_pool_terminate</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g62a5b0e72b40f9141c0548678e77182a">apr_pool_create_ex</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> **newpool, <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *parent, <a class="el" href="group__apr__pools.html#ga49969ddb0e43ef8f7053de6cec11986">apr_abortfunc_t</a> abort_fn, <a class="el" href="group__apr__allocator.html#g7c54745bdc959966aef3b262ce2d1503">apr_allocator_t</a> *allocator)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g77ed424b0c24eff22e48608b7c30abbb">apr_pool_create_ex_debug</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> **newpool, <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *parent, <a class="el" href="group__apr__pools.html#ga49969ddb0e43ef8f7053de6cec11986">apr_abortfunc_t</a> abort_fn, <a class="el" href="group__apr__allocator.html#g7c54745bdc959966aef3b262ce2d1503">apr_allocator_t</a> *allocator, const char *file_line)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g645d6ed2ce27f392276bf09f2a9b8280">apr_pool_create</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> **newpool, <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__allocator.html#g7c54745bdc959966aef3b262ce2d1503">apr_allocator_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga88b0273893861bb6b8e6239a3200ee9">apr_pool_allocator_get</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ge1e4e67789e3e159f693d786850464ff">apr_pool_clear</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g5907358faffcda15331b31bf54df15a4">apr_pool_clear_debug</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, const char *file_line)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gf9e500b2fa068b575e2c58839f0fd4fe">apr_pool_destroy</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gffc6f9a0dd33dfdabd0a1ad006a4b4a3">apr_pool_destroy_debug</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, const char *file_line)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g8e1dc68928a503f4b57e895d0d491eae">apr_palloc</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, apr_size_t size)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g0b0dbbaef79747b782dc1679a20cea0e">apr_palloc_debug</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, apr_size_t size, const char *file_line)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g6e0be4d4606f57a5b195a3b4f94e2859">apr_pcalloc</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, apr_size_t size)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g9bb3ff72d6d84673f4836d244175435a">apr_pcalloc_debug</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, apr_size_t size, const char *file_line)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gf7dcf69ba4da14b14837fb783b489680">apr_pool_abort_set</a> (<a class="el" href="group__apr__pools.html#ga49969ddb0e43ef8f7053de6cec11986">apr_abortfunc_t</a> abortfunc, <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__pools.html#ga49969ddb0e43ef8f7053de6cec11986">apr_abortfunc_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g972fd3a2640d84674f79cc70baf6ccac">apr_pool_abort_get</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g59728f18dc628f2746c31bd9627d5ab1">apr_pool_parent_get</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gad5be4ef1bc1f98bc1ec9ce99d3675a9">apr_pool_is_ancestor</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *a, <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *b)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#gf47f2850c94b5a8471201e353199a1de">apr_pool_tag</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *pool, const char *tag)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g52753379b14d4e858a2121d06c1f7b58">apr_pool_userdata_set</a> (const void *data, const char *key, <a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>(*cleanup)(void *), <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#g1201e55f4a2ecccc0f76791af35e63bb">apr_pool_userdata_setn</a> (const void *data, const char *key, <a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>(*cleanup)(void *), <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga9da04d2a1b1cf5441157ca802f5ac6e">apr_pool_userdata_get</a> (void **data, const char *key, <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pool_cleanup.html#g6e4b80cf5de3d83fdba45657cb560550">apr_pool_cleanup_register</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, const void *data, <a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>(*plain_cleanup)(void *), <a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>(*child_cleanup)(void *))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pool_cleanup.html#g294840aee540d952fedb2004340fd49e">apr_pool_pre_cleanup_register</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, const void *data, <a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>(*plain_cleanup)(void *))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pool_cleanup.html#g01ebbef4842f1b221c60506c1819a24c">apr_pool_cleanup_kill</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, const void *data, <a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>(*cleanup)(void *))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pool_cleanup.html#gbc7b1aa9e851f10eff33c20baea8a4ac">apr_pool_child_cleanup_set</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, const void *data, <a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>(*plain_cleanup)(void *), <a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>(*child_cleanup)(void *))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pool_cleanup.html#g06794d40cfee7f9357631ed6d99a9660">apr_pool_cleanup_run</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, void *data, <a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>(*cleanup)(void *))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pool_cleanup.html#g5b829fedf845e099c3de5c7cbf014c86">apr_pool_cleanup_null</a> (void *data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pool_cleanup.html#gbb95360d0c103c5dfa1848ac31b2c3eb">apr_pool_cleanup_for_exec</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pool_debug.html#g9165cfa05653d8016714f4fa922d8c75">apr_pool_join</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *sub)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pool_debug.html#gc3585701def228f48ced26e5d573348d">apr_pool_find</a> (const void *mem)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">apr_size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pool_debug.html#g3461dcf543818ac61f808f03e79f3f0d">apr_pool_num_bytes</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p, int recurse)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group___pool_debug.html#gcbc105ca57079b649760f449899ffe32">apr_pool_lock</a> (<a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *pool, int flag)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
APR memory allocation.
<p>
Resource allocation routines...<p>
designed so that we don't have to keep track of EVERYTHING so that it can be explicitly freed later (a fundamentally unsound strategy --- particularly in the presence of die()).<p>
Instead, we maintain pools, and allocate items (both memory and I/O handlers) from the pools --- currently there are two, one for per transaction info, and one for config info. When a transaction is over, we can delete everything in the per-transaction apr_pool_t without fear, and without thinking too hard about it either. <hr><h2>Define Documentation</h2>
<a class="anchor" name="b8737b3e89f7da73a0d8d89e75a2e856"></a><!-- doxytag: member="apr_pools.h::APR_WANT_MEMFUNC" ref="b8737b3e89f7da73a0d8d89e75a2e856" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_WANT_MEMFUNC </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
for no good reason?
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Tue May 31 12:20:26 2011 for Apache Portable Runtime by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
