<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>Apache Portable Runtime Utility Library: apr_bucket_pool Struct 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.5.4 --> <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="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> <h1>apr_bucket_pool Struct Reference<br> <small> [<a class="el" href="group___a_p_r___util___bucket___brigades.html">Bucket Brigades</a>]</small> </h1><!-- doxytag: class="apr_bucket_pool" --><code>#include <<a class="el" href="apr__buckets_8h-source.html">apr_buckets.h</a>></code> <p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structapr__bucket__heap.html">apr_bucket_heap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__bucket__pool.html#0fe0b0dedea28fb1ed0a1a0f42338225">heap</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__bucket__pool.html#9ee5297361ba548a20c3aa626a37c068">base</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">apr_pool_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__bucket__pool.html#f55591a1e7f3b097e7c271683bc80968">pool</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group___a_p_r___util___bucket___brigades.html#g9a30babfeb6e290db124d8f9b69e49e4">apr_bucket_alloc_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__bucket__pool.html#651aa0c18658342daf72ff86680bfaca">list</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> A bucket referring to data allocated from a pool <hr><h2>Field Documentation</h2> <a class="anchor" name="0fe0b0dedea28fb1ed0a1a0f42338225"></a><!-- doxytag: member="apr_bucket_pool::heap" ref="0fe0b0dedea28fb1ed0a1a0f42338225" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="structapr__bucket__heap.html">apr_bucket_heap</a> <a class="el" href="structapr__bucket__pool.html#0fe0b0dedea28fb1ed0a1a0f42338225">apr_bucket_pool::heap</a> </td> </tr> </table> </div> <div class="memdoc"> <p> The pool bucket must be able to be easily morphed to a heap bucket if the pool gets cleaned up before all references are destroyed. This <a class="el" href="structapr__bucket__heap.html">apr_bucket_heap</a> structure is populated automatically when the pool gets cleaned up, and subsequent calls to pool_read() will result in the <a class="el" href="structapr__bucket.html">apr_bucket</a> in question being morphed into a regular heap bucket. (To avoid having to do many extra refcount manipulations and b->data manipulations, the <a class="el" href="structapr__bucket__pool.html">apr_bucket_pool</a> struct actually *contains* the <a class="el" href="structapr__bucket__heap.html">apr_bucket_heap</a> struct that it will become as its first element; the two share their <a class="el" href="structapr__bucket__refcount.html">apr_bucket_refcount</a> members.) </div> </div><p> <a class="anchor" name="9ee5297361ba548a20c3aa626a37c068"></a><!-- doxytag: member="apr_bucket_pool::base" ref="9ee5297361ba548a20c3aa626a37c068" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="structapr__bucket__pool.html#9ee5297361ba548a20c3aa626a37c068">apr_bucket_pool::base</a> </td> </tr> </table> </div> <div class="memdoc"> <p> The block of data actually allocated from the pool. Segments of this block are referenced by adjusting the start and length of the <a class="el" href="structapr__bucket.html">apr_bucket</a> accordingly. This will be NULL after the pool gets cleaned up. </div> </div><p> <a class="anchor" name="f55591a1e7f3b097e7c271683bc80968"></a><!-- doxytag: member="apr_bucket_pool::pool" ref="f55591a1e7f3b097e7c271683bc80968" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">apr_pool_t* <a class="el" href="structapr__bucket__pool.html#f55591a1e7f3b097e7c271683bc80968">apr_bucket_pool::pool</a> </td> </tr> </table> </div> <div class="memdoc"> <p> The pool the data was allocated from. When the pool is cleaned up, this gets set to NULL as an indicator to pool_read() that the data is now on the heap and so it should morph the bucket into a regular heap bucket before continuing. </div> </div><p> <a class="anchor" name="651aa0c18658342daf72ff86680bfaca"></a><!-- doxytag: member="apr_bucket_pool::list" ref="651aa0c18658342daf72ff86680bfaca" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group___a_p_r___util___bucket___brigades.html#g9a30babfeb6e290db124d8f9b69e49e4">apr_bucket_alloc_t</a>* <a class="el" href="structapr__bucket__pool.html#651aa0c18658342daf72ff86680bfaca">apr_bucket_pool::list</a> </td> </tr> </table> </div> <div class="memdoc"> <p> The freelist this structure was allocated from, which is needed in the cleanup phase in order to allocate space on the heap </div> </div><p> <hr>The documentation for this struct was generated from the following file:<ul> <li>include/<a class="el" href="apr__buckets_8h-source.html">apr_buckets.h</a></ul> <hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 24 02:22:55 2008 for Apache Portable Runtime Utility Library by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address> </body> </html>