<!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: Memory Pool Functions</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>
<h1>Memory Pool Functions<br>
<small>
[<a class="el" href="group__APR.html">Apache Portability Runtime library</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Modules</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">group </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PoolDebug.html">Pool Debugging functions.</a></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="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>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="ga33" doxytag="apr_pools.h::APR_POOL__FILE_LINE__"></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_POOL__FILE_LINE__ __FILE__ ":" APR_STRINGIFY(__LINE__) </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
the place in the code where the particular function was called </td>
</tr>
</table>
<a class="anchor" name="ga32" doxytag="apr_pools.h::APR_POOL_DEBUG"></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_POOL_DEBUG 0 </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Pool debug levels<p>
<pre>
| 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
---------------------------------
| | | | | | | | x | General debug code enabled (useful in
combination with --with-efence).</pre><p>
<pre> | | | | | | | x | | Verbose output on stderr (report
CREATE, CLEAR, DESTROY).</pre><p>
<pre> | | | | x | | | | | Verbose output on stderr (report
PALLOC, PCALLOC).</pre><p>
<pre> | | | | | | x | | | Lifetime checking. On each use of a
pool, check its lifetime. If the pool
is out of scope, abort().
In combination with the verbose flag
above, it will output LIFE in such an
event prior to aborting.</pre><p>
<pre> | | | | | x | | | | Pool owner checking. On each use of a
pool, check if the current thread is the
pools owner. If not, abort(). In
combination with the verbose flag above,
it will output OWNER in such an event
prior to aborting. Use the debug
function apr_pool_owner_set() to switch
a pools ownership.</pre><p>
<pre> When no debug level was specified, assume general debug mode.
If level 0 was specified, debugging is switched off
</pre> </td>
</tr>
</table>
<a class="anchor" name="ga30" doxytag="apr_pools.h::APR_POOL_DECLARE_ACCESSOR"></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_POOL_DECLARE_ACCESSOR </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">type </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="group__apr__platform.html#ga123">APR_DECLARE</a>(apr_pool_t *) apr_##type##_pool_get \
(const apr_##type##_t *the##type)
</pre></div>Declaration helper macro to construct apr_foo_pool_get()s.<p>
This standardized macro is used by opaque (APR) data types to return the apr_pool_t that is associated with the data type.<p>
<a class="el" href="group__apr__pools.html#ga30">APR_POOL_DECLARE_ACCESSOR()</a> is used in a header file to declare the accessor function. A typical usage and result would be: <pre>
<a class="el" href="group__apr__pools.html#ga30">APR_POOL_DECLARE_ACCESSOR(file)</a>;
becomes:
<a class="el" href="group__apr__platform.html#ga123">APR_DECLARE(apr_pool_t *)</a> apr_file_pool_get(apr_file_t *ob);
</pre> <dl compact><dt><b>Remarks:</b></dt><dd>Doxygen unwraps this macro (via doxygen.conf) to provide actual help for each specific occurance of apr_foo_pool_get. <p>
the linkage is specified for APR. It would be possible to expand the macros to support other linkages. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga31" doxytag="apr_pools.h::APR_POOL_IMPLEMENT_ACCESSOR"></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_POOL_IMPLEMENT_ACCESSOR </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">type </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><a class="code" href="group__apr__platform.html#ga123">APR_DECLARE</a>(apr_pool_t *) apr_##type##_pool_get \
(const apr_##type##_t *the##type) \
{ <span class="keywordflow">return</span> the##type->pool; }
</pre></div>Implementation helper macro to provide apr_foo_pool_get()s.<p>
In the implementation, the <a class="el" href="group__apr__pools.html#ga31">APR_POOL_IMPLEMENT_ACCESSOR()</a> is used to actually define the function. It assumes the field is named "pool". </td>
</tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="ga1" doxytag="apr_pools.h::apr_abortfunc_t"></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">typedef int(* <a class="el" href="group__apr__pools.html#ga1">apr_abortfunc_t</a>)(int retcode) </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A function that is called when allocation fails. </td>
</tr>
</table>
<a class="anchor" name="ga0" doxytag="apr_pools.h::apr_pool_t"></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">typedef struct <a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> <a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
The fundamental pool type </td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="ga12" doxytag="apr_pools.h::apr_palloc"></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">void* apr_palloc </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>p</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>apr_size_t </td>
<td class="mdname" nowrap> <em>size</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Allocate a block of memory from a pool <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>The pool to allocate from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>The amount of memory to allocate </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The allocated memory </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga13" doxytag="apr_pools.h::apr_palloc_debug"></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">void* apr_palloc_debug </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>p</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>apr_size_t </td>
<td class="mdname" nowrap> <em>size</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>file_line</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Debug version of apr_palloc <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>See: apr_palloc </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>See: apr_palloc </td></tr>
<tr><td valign="top"></td><td valign="top"><em>file_line</em> </td><td>Where the function is called from. This is usually APR_POOL__FILE_LINE__. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>See: apr_palloc </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga14" doxytag="apr_pools.h::apr_pcalloc"></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">void* apr_pcalloc </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>p</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>apr_size_t </td>
<td class="mdname" nowrap> <em>size</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Allocate a block of memory from a pool and set all of the memory to 0 <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>The pool to allocate from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>The amount of memory to allocate </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The allocated memory </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga15" doxytag="apr_pools.h::apr_pcalloc_debug"></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">void* apr_pcalloc_debug </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>p</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>apr_size_t </td>
<td class="mdname" nowrap> <em>size</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>file_line</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Debug version of apr_pcalloc <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>See: apr_pcalloc </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>See: apr_pcalloc </td></tr>
<tr><td valign="top"></td><td valign="top"><em>file_line</em> </td><td>Where the function is called from. This is usually APR_POOL__FILE_LINE__. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>See: apr_pcalloc </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga17" doxytag="apr_pools.h::apr_pool_abort_get"></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"><a class="el" href="group__apr__pools.html#ga1">apr_abortfunc_t</a> apr_pool_abort_get </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>pool</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the abort function associated with the specified pool. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>The pool for retrieving the abort function. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The abort function for the given pool. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga16" doxytag="apr_pools.h::apr_pool_abort_set"></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">void apr_pool_abort_set </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga1">apr_abortfunc_t</a> </td>
<td class="mdname" nowrap> <em>abortfunc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>pool</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the function to be called when an allocation failure occurs. <dl compact><dt><b>Remarks:</b></dt><dd>If the program wants APR to exit on a memory allocation error, then this function can be called to set the callback to use (for performing cleanup and then exiting). If this function is not called, then APR will return an error and expect the calling program to deal with the error accordingly. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga7" doxytag="apr_pools.h::apr_pool_allocator_get"></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"><a class="el" href="group__apr__allocator.html#ga0">apr_allocator_t</a>* apr_pool_allocator_get </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>pool</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Find the pools allocator <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>The pool to get the allocator from. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga26" doxytag="apr_pools.h::apr_pool_child_cleanup_set"></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">void apr_pool_child_cleanup_set </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>p</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const void * </td>
<td class="mdname" nowrap> <em>data</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a>(*)(void *) </td>
<td class="mdname" nowrap> <em>plain_cleanup</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a>(*)(void *) </td>
<td class="mdname" nowrap> <em>child_cleanup</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Replace the child cleanup of a previously registered cleanup <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>The pool of the registered cleanup </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The data of the registered cleanup </td></tr>
<tr><td valign="top"></td><td valign="top"><em>plain_cleanup</em> </td><td>The plain cleanup function of the registered cleanup </td></tr>
<tr><td valign="top"></td><td valign="top"><em>child_cleanup</em> </td><td>The function to register as the child cleanup </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga29" doxytag="apr_pools.h::apr_pool_cleanup_for_exec"></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">void apr_pool_cleanup_for_exec </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Run all of the child_cleanups, so that any unnecessary files are closed because we are about to exec a new program </td>
</tr>
</table>
<a class="anchor" name="ga25" doxytag="apr_pools.h::apr_pool_cleanup_kill"></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">void apr_pool_cleanup_kill </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>p</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const void * </td>
<td class="mdname" nowrap> <em>data</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a>(*)(void *) </td>
<td class="mdname" nowrap> <em>cleanup</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Remove a previously registered cleanup function <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>The pool remove the cleanup from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The data to remove from cleanup </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cleanup</em> </td><td>The function to remove from cleanup </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><dd>For some strange reason only the plain_cleanup is handled by this function </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga28" doxytag="apr_pools.h::apr_pool_cleanup_null"></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"><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a> apr_pool_cleanup_null </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname1" valign="top" nowrap> <em>data</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
An empty cleanup function <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The data to cleanup </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga24" doxytag="apr_pools.h::apr_pool_cleanup_register"></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">void apr_pool_cleanup_register </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>p</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const void * </td>
<td class="mdname" nowrap> <em>data</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a>(*)(void *) </td>
<td class="mdname" nowrap> <em>plain_cleanup</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a>(*)(void *) </td>
<td class="mdname" nowrap> <em>child_cleanup</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Register a function to be called when a pool is cleared or destroyed <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>The pool register the cleanup with </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The data to pass to the cleanup function. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>plain_cleanup</em> </td><td>The function to call when the pool is cleared or destroyed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>child_cleanup</em> </td><td>The function to call when a child process is about to exec - this function is called in the child, obviously! </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga27" doxytag="apr_pools.h::apr_pool_cleanup_run"></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"><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a> apr_pool_cleanup_run </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>p</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>void * </td>
<td class="mdname" nowrap> <em>data</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a>(*)(void *) </td>
<td class="mdname" nowrap> <em>cleanup</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Run the specified cleanup function immediately and unregister it. Use <em>data</em> instead of the data that was registered with the cleanup. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>The pool remove the cleanup from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The data to remove from cleanup </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cleanup</em> </td><td>The function to remove from cleanup </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga8" doxytag="apr_pools.h::apr_pool_clear"></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">void apr_pool_clear </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>p</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Clear all memory in the pool and run all the cleanups. This also destroys all subpools. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>The pool to clear </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><dd>This does not actually free the memory, it just allows the pool to re-use this memory for the next allocation. </dd></dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__apr__pools.html#ga10">apr_pool_destroy()</a> </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga9" doxytag="apr_pools.h::apr_pool_clear_debug"></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">void apr_pool_clear_debug </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>p</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>file_line</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Debug version of apr_pool_clear. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>See: apr_pool_clear. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>file_line</em> </td><td>Where the function is called from. This is usually APR_POOL__FILE_LINE__. </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><dd>Only available when APR_POOL_DEBUG is defined. Call this directly if you have you apr_pool_clear calls in a wrapper function and wish to override the file_line argument to reflect the caller of your wrapper function. If you do not have apr_pool_clear in a wrapper, trust the macro and don't call apr_pool_destroy_clear directly. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga6" doxytag="apr_pools.h::apr_pool_create"></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"><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a> apr_pool_create </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> ** </td>
<td class="mdname" nowrap> <em>newpool</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>parent</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a new pool. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newpool</em> </td><td>The pool we have just created. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>parent</em> </td><td>The parent pool. If this is NULL, the new pool is a root pool. If it is non-NULL, the new pool will inherit all of its parent pool's attributes, except the apr_pool_t will be a sub-pool. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga4" doxytag="apr_pools.h::apr_pool_create_ex"></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"><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a> apr_pool_create_ex </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> ** </td>
<td class="mdname" nowrap> <em>newpool</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>parent</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__pools.html#ga1">apr_abortfunc_t</a> </td>
<td class="mdname" nowrap> <em>abort_fn</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__allocator.html#ga0">apr_allocator_t</a> * </td>
<td class="mdname" nowrap> <em>allocator</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Create a new pool. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newpool</em> </td><td>The pool we have just created. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>parent</em> </td><td>The parent pool. If this is NULL, the new pool is a root pool. If it is non-NULL, the new pool will inherit all of its parent pool's attributes, except the apr_pool_t will be a sub-pool. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>abort_fn</em> </td><td>A function to use if the pool cannot allocate more memory. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>allocator</em> </td><td>The allocator to use with the new pool. If NULL the allocator of the parent pool will be used. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga5" doxytag="apr_pools.h::apr_pool_create_ex_debug"></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"><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a> apr_pool_create_ex_debug </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> ** </td>
<td class="mdname" nowrap> <em>newpool</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>parent</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__pools.html#ga1">apr_abortfunc_t</a> </td>
<td class="mdname" nowrap> <em>abort_fn</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__allocator.html#ga0">apr_allocator_t</a> * </td>
<td class="mdname" nowrap> <em>allocator</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>file_line</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Debug version of apr_pool_create_ex. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newpool</em> </td><td></td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__apr__pools.html#ga6">apr_pool_create</a>. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>parent</em> </td><td></td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__apr__pools.html#ga6">apr_pool_create</a>. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>abort_fn</em> </td><td></td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__apr__pools.html#ga6">apr_pool_create</a>. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>allocator</em> </td><td></td></tr>
</table>
</dl>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="group__apr__pools.html#ga6">apr_pool_create</a>. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>file_line</em> </td><td>Where the function is called from. This is usually APR_POOL__FILE_LINE__. </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><dd>Only available when APR_POOL_DEBUG is defined. Call this directly if you have you apr_pool_create_ex calls in a wrapper function and wish to override the file_line argument to reflect the caller of your wrapper function. If you do not have apr_pool_create_ex in a wrapper, trust the macro and don't call apr_pool_create_ex_debug directly. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga10" doxytag="apr_pools.h::apr_pool_destroy"></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">void apr_pool_destroy </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>p</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Destroy the pool. This takes similar action as <a class="el" href="group__apr__pools.html#ga8">apr_pool_clear()</a> and then frees all the memory. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>The pool to destroy </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><dd>This will actually free the memory </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga11" doxytag="apr_pools.h::apr_pool_destroy_debug"></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">void apr_pool_destroy_debug </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>p</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>file_line</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Debug version of apr_pool_destroy. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>See: apr_pool_destroy. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>file_line</em> </td><td>Where the function is called from. This is usually APR_POOL__FILE_LINE__. </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><dd>Only available when APR_POOL_DEBUG is defined. Call this directly if you have you apr_pool_destroy calls in a wrapper function and wish to override the file_line argument to reflect the caller of your wrapper function. If you do not have apr_pool_destroy in a wrapper, trust the macro and don't call apr_pool_destroy_debug directly. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga2" doxytag="apr_pools.h::apr_pool_initialize"></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"><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a> apr_pool_initialize </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Setup all of the internal structures required to use pools <dl compact><dt><b>Remarks:</b></dt><dd>Programs do NOT need to call this directly. APR will call this automatically from apr_initialize. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga19" doxytag="apr_pools.h::apr_pool_is_ancestor"></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">int apr_pool_is_ancestor </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>a</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>b</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Determine if pool a is an ancestor of pool b <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>a</em> </td><td>The pool to search </td></tr>
<tr><td valign="top"></td><td valign="top"><em>b</em> </td><td>The pool to search for </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>True if a is an ancestor of b, NULL is considered an ancestor of all pools. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga18" doxytag="apr_pools.h::apr_pool_parent_get"></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"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a>* apr_pool_parent_get </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>pool</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the parent pool of the specified pool. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>The pool for retrieving the parent pool. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>The parent of the given pool. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga20" doxytag="apr_pools.h::apr_pool_tag"></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">void apr_pool_tag </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>pool</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>tag</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Tag a pool (give it a name) <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>The pool to tag </td></tr>
<tr><td valign="top"></td><td valign="top"><em>tag</em> </td><td>The tag </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga3" doxytag="apr_pools.h::apr_pool_terminate"></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">void apr_pool_terminate </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Tear down all of the internal structures required to use pools <dl compact><dt><b>Remarks:</b></dt><dd>Programs do NOT need to call this directly. APR will call this automatically from apr_terminate. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ga23" doxytag="apr_pools.h::apr_pool_userdata_get"></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"><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a> apr_pool_userdata_get </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void ** </td>
<td class="mdname" nowrap> <em>data</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>key</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>pool</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Return the data associated with the current pool. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The user data associated with the pool. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key for the data to retrieve </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>The current pool. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="ga21" doxytag="apr_pools.h::apr_pool_userdata_set"></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"><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a> apr_pool_userdata_set </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const void * </td>
<td class="mdname" nowrap> <em>data</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>key</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a>(*)(void *) </td>
<td class="mdname" nowrap> <em>cleanup</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>pool</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the data associated with the current pool <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The user data associated with the pool. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key to use for association </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cleanup</em> </td><td>The cleanup program to use to cleanup the data (NULL if none) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>The current pool </td></tr>
</table>
</dl>
<dl compact><dt><b>Warning:</b></dt><dd>The data to be attached to the pool should have a life span at least as long as the pool it is being attached to.</dd></dl>
Users of APR must take EXTREME care when choosing a key to use for their data. It is possible to accidentally overwrite data by choosing a key that another part of the program is using. Therefore it is advised that steps are taken to ensure that unique keys are used for all of the userdata objects in a particular pool (the same key in two different pools or a pool and one of its subpools is okay) at all times. Careful namespace prefixing of key names is a typical way to help ensure this uniqueness. </td>
</tr>
</table>
<a class="anchor" name="ga22" doxytag="apr_pools.h::apr_pool_userdata_setn"></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"><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a> apr_pool_userdata_setn </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const void * </td>
<td class="mdname" nowrap> <em>data</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>key</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__errno.html#ga0">apr_status_t</a>(*)(void *) </td>
<td class="mdname" nowrap> <em>cleanup</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="group__apr__pools.html#ga0">apr_pool_t</a> * </td>
<td class="mdname" nowrap> <em>pool</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Set the data associated with the current pool <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The user data associated with the pool. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key to use for association </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cleanup</em> </td><td>The cleanup program to use to cleanup the data (NULL if none) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>The current pool </td></tr>
</table>
</dl>
<dl compact><dt><b>Note:</b></dt><dd>same as <a class="el" href="group__apr__pools.html#ga21">apr_pool_userdata_set()</a>, except that this version doesn't make a copy of the key (this function is useful, for example, when the key is a string literal) </dd></dl>
<dl compact><dt><b>Warning:</b></dt><dd>This should NOT be used if the key could change addresses by any means between the <a class="el" href="group__apr__pools.html#ga22">apr_pool_userdata_setn()</a> call and a subsequent <a class="el" href="group__apr__pools.html#ga23">apr_pool_userdata_get()</a> on that key, such as if a static string is used as a userdata key in a DSO and the DSO could be unloaded and reloaded between the _setn() and the _get(). You MUST use <a class="el" href="group__apr__pools.html#ga21">apr_pool_userdata_set()</a> in such cases. <p>
More generally, the key and the data to be attached to the pool should have a life span at least as long as the pool itself. </dd></dl>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Sun Mar 20 19:52:27 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>
distrib
>
Mandriva
>
10.2
>
i586
>
media
>
contrib
>
by-pkgid
>
4f37b923758ceff94a2c0ccca62b4b43
>
files
>
187
