<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Apache Portable Runtime Utility Library: apr_bucket Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.6.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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>
<div id="MSearchBox" class="MSearchBoxInactive">
<img id="MSearchSelect" src="search/search.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</div>
</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>
</div>
<div class="contents">
<h1>apr_bucket 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" -->
<p><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 colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__bucket.html#ab1acff965e57e067dfde80321d04dea7">APR_RING_ENTRY</a> (<a class="el" href="structapr__bucket.html">apr_bucket</a>) link</td></tr>
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structapr__bucket__type__t.html">apr_bucket_type_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__bucket.html#ac27fa5ce798e688ad243ebe1615937fc">type</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">apr_size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__bucket.html#a0898dfc78d9275187189b9a745e619bf">length</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">apr_off_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__bucket.html#a4a8791b606b3ad613b8672ec94145628">start</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__bucket.html#a7fc4604750889b3f762bda1a786d276a">data</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__bucket.html#ac50b1c1de2b171938c33bf3ac478f359">free</a> )(void *e)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___a_p_r___util___bucket___brigades.html#ga9a30babfeb6e290db124d8f9b69e49e4">apr_bucket_alloc_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__bucket.html#a5a500b80105834621514d6c0814d0966">list</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="structapr__bucket.html">apr_bucket</a> structures are allocated on the malloc() heap and their lifetime is controlled by the parent <a class="el" href="structapr__bucket__brigade.html">apr_bucket_brigade</a> structure. Buckets can move from one brigade to another e.g. by calling <a class="el" href="group___a_p_r___util___bucket___brigades.html#ga7cecbc89be912ce9ab24c889eb8f955b">APR_BRIGADE_CONCAT()</a>. In general the data in a bucket has the same lifetime as the bucket and is freed when the bucket is destroyed; if the data is shared by more than one bucket (e.g. after a split) the data is freed when the last bucket goes away. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ab1acff965e57e067dfde80321d04dea7"></a><!-- doxytag: member="apr_bucket::APR_RING_ENTRY" ref="ab1acff965e57e067dfde80321d04dea7" args="(apr_bucket) link" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_bucket::APR_RING_ENTRY </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structapr__bucket.html">apr_bucket</a> </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Links to the rest of the brigade </p>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a7fc4604750889b3f762bda1a786d276a"></a><!-- doxytag: member="apr_bucket::data" ref="a7fc4604750889b3f762bda1a786d276a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* <a class="el" href="structapr__bucket.html#a7fc4604750889b3f762bda1a786d276a">apr_bucket::data</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>type-dependent data hangs off this pointer </p>
</div>
</div>
<a class="anchor" id="ac50b1c1de2b171938c33bf3ac478f359"></a><!-- doxytag: member="apr_bucket::free" ref="ac50b1c1de2b171938c33bf3ac478f359" args=")(void *e)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void(* <a class="el" href="structapr__bucket.html#ac50b1c1de2b171938c33bf3ac478f359">apr_bucket::free</a>)(void *e)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to function used to free the bucket. This function should always be defined and it should be consistent with the memory function used to allocate the bucket. For example, if malloc() is used to allocate the bucket, this pointer should point to <a class="el" href="structapr__bucket.html#ac50b1c1de2b171938c33bf3ac478f359">free()</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>e</em> </td><td>Pointer to the bucket being freed </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a0898dfc78d9275187189b9a745e619bf"></a><!-- doxytag: member="apr_bucket::length" ref="a0898dfc78d9275187189b9a745e619bf" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_size_t <a class="el" href="structapr__bucket.html#a0898dfc78d9275187189b9a745e619bf">apr_bucket::length</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The length of the data in the bucket. This could have been implemented with a function, but this is an optimization, because the most common thing to do will be to get the length. If the length is unknown, the value of this field will be (apr_size_t)(-1). </p>
</div>
</div>
<a class="anchor" id="a5a500b80105834621514d6c0814d0966"></a><!-- doxytag: member="apr_bucket::list" ref="a5a500b80105834621514d6c0814d0966" 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#ga9a30babfeb6e290db124d8f9b69e49e4">apr_bucket_alloc_t</a>* <a class="el" href="structapr__bucket.html#a5a500b80105834621514d6c0814d0966">apr_bucket::list</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The freelist from which this bucket was allocated </p>
</div>
</div>
<a class="anchor" id="a4a8791b606b3ad613b8672ec94145628"></a><!-- doxytag: member="apr_bucket::start" ref="a4a8791b606b3ad613b8672ec94145628" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_off_t <a class="el" href="structapr__bucket.html#a4a8791b606b3ad613b8672ec94145628">apr_bucket::start</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The start of the data in the bucket relative to the private base pointer. The vast majority of bucket types allow a fixed block of data to be referenced by multiple buckets, each bucket pointing to a different segment of the data. That segment starts at base+start and ends at base+start+length. If the length == (apr_size_t)(-1), then start == -1. </p>
</div>
</div>
<a class="anchor" id="ac27fa5ce798e688ad243ebe1615937fc"></a><!-- doxytag: member="apr_bucket::type" ref="ac27fa5ce798e688ad243ebe1615937fc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structapr__bucket__type__t.html">apr_bucket_type_t</a>* <a class="el" href="structapr__bucket.html#ac27fa5ce798e688ad243ebe1615937fc">apr_bucket::type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The type of bucket. </p>
</div>
</div>
<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></li>
</ul>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Feb 1 12:19:48 2012 for Apache Portable Runtime Utility Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
7c859c6f61469ed11e2ab179848b0178
>
files
>
270
