<!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">
</head><body>
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<div class="nav">
<a class="el" href="dir_000000.html">home</a> / <a class="el" href="dir_000001.html">oden</a> / <a class="el" href="dir_000002.html">RPM</a> / <a class="el" href="dir_000003.html">BUILD</a> / <a class="el" href="dir_000004.html">apr-1.1.1</a> / <a class="el" href="dir_000005.html">include</a></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#a0">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#ga30">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#ga31">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#ga32">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#ga33">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#ga0">apr_pool_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga0">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#ga1">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#ga0">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga2">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#ga3">apr_pool_terminate</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga4">apr_pool_create_ex</a> (<a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> **newpool, <a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *parent, <a class="el" href="group__apr__pools.html#ga1">apr_abortfunc_t</a> abort_fn, <a class="el" href="group__apr__allocator.html#ga0">apr_allocator_t</a> *allocator)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga5">apr_pool_create_ex_debug</a> (<a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> **newpool, <a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *parent, <a class="el" href="group__apr__pools.html#ga1">apr_abortfunc_t</a> abort_fn, <a class="el" href="group__apr__allocator.html#ga0">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#ga0">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga6">apr_pool_create</a> (<a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> **newpool, <a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__allocator.html#ga0">apr_allocator_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga7">apr_pool_allocator_get</a> (<a class="el" href="group__apr__pools.html#ga0">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#ga8">apr_pool_clear</a> (<a class="el" href="group__apr__pools.html#ga0">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#ga9">apr_pool_clear_debug</a> (<a class="el" href="group__apr__pools.html#ga0">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#ga10">apr_pool_destroy</a> (<a class="el" href="group__apr__pools.html#ga0">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#ga11">apr_pool_destroy_debug</a> (<a class="el" href="group__apr__pools.html#ga0">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#ga12">apr_palloc</a> (<a class="el" href="group__apr__pools.html#ga0">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#ga13">apr_palloc_debug</a> (<a class="el" href="group__apr__pools.html#ga0">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#ga14">apr_pcalloc</a> (<a class="el" href="group__apr__pools.html#ga0">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#ga15">apr_pcalloc_debug</a> (<a class="el" href="group__apr__pools.html#ga0">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#ga16">apr_pool_abort_set</a> (<a class="el" href="group__apr__pools.html#ga1">apr_abortfunc_t</a> abortfunc, <a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__pools.html#ga1">apr_abortfunc_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga17">apr_pool_abort_get</a> (<a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga18">apr_pool_parent_get</a> (<a class="el" href="group__apr__pools.html#ga0">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#ga19">apr_pool_is_ancestor</a> (<a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *a, <a class="el" href="group__apr__pools.html#ga0">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#ga20">apr_pool_tag</a> (<a class="el" href="group__apr__pools.html#ga0">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#ga0">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga21">apr_pool_userdata_set</a> (const void *data, const char *key, <a class="el" href="group__apr__errno.html#ga0">apr_status_t</a>(*cleanup)(void *), <a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga22">apr_pool_userdata_setn</a> (const void *data, const char *key, <a class="el" href="group__apr__errno.html#ga0">apr_status_t</a>(*cleanup)(void *), <a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga23">apr_pool_userdata_get</a> (void **data, const char *key, <a class="el" href="group__apr__pools.html#ga0">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#ga24">apr_pool_cleanup_register</a> (<a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *p, const void *data, <a class="el" href="group__apr__errno.html#ga0">apr_status_t</a>(*plain_cleanup)(void *), <a class="el" href="group__apr__errno.html#ga0">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__apr__pools.html#ga25">apr_pool_cleanup_kill</a> (<a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *p, const void *data, <a class="el" href="group__apr__errno.html#ga0">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__apr__pools.html#ga26">apr_pool_child_cleanup_set</a> (<a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *p, const void *data, <a class="el" href="group__apr__errno.html#ga0">apr_status_t</a>(*plain_cleanup)(void *), <a class="el" href="group__apr__errno.html#ga0">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#ga0">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga27">apr_pool_cleanup_run</a> (<a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *p, void *data, <a class="el" href="group__apr__errno.html#ga0">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#ga0">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__pools.html#ga28">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__apr__pools.html#ga29">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__PoolDebug.html#ga0">apr_pool_join</a> (<a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *p, <a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> *sub)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PoolDebug.html#ga1">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__PoolDebug.html#ga2">apr_pool_num_bytes</a> (<a class="el" href="group__apr__pools.html#ga0">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__PoolDebug.html#ga3">apr_pool_lock</a> (<a class="el" href="group__apr__pools.html#ga0">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="a0" doxytag="apr_pools.h::APR_WANT_MEMFUNC"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">#define APR_WANT_MEMFUNC </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
for no good reason? </td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun Mar 20 19:52:26 2005 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.3.9.1 </small></address>
</body>
</html>
