<!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: apr_reslist.h Source File</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.7.3 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache Portable Runtime</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.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)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>apr_reslist.h</h1> </div>
</div>
<div class="contents">
<a href="apr__reslist_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00002"></a>00002 <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span>
<a name="l00003"></a>00003 <span class="comment"> * this work for additional information regarding copyright ownership.</span>
<a name="l00004"></a>00004 <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span>
<a name="l00005"></a>00005 <span class="comment"> * (the "License"); you may not use this file except in compliance with</span>
<a name="l00006"></a>00006 <span class="comment"> * the License. You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"> */</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef APR_RESLIST_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_RESLIST_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">/** </span>
<a name="l00021"></a>00021 <span class="comment"> * @file apr_reslist.h</span>
<a name="l00022"></a>00022 <span class="comment"> * @brief APR-UTIL Resource List Routines</span>
<a name="l00023"></a>00023 <span class="comment"> */</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="apr_8h.html" title="APR Platform Definitions.">apr.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "apu.h"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html" title="APR memory allocation.">apr_pools.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html" title="APR Error Codes.">apr_errno.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="apr__time_8h.html" title="APR Time Library.">apr_time.h</a>"</span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#if APR_HAS_THREADS</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00033"></a>00033 <span class="comment">/**</span>
<a name="l00034"></a>00034 <span class="comment"> * @defgroup APR_Util_RL Resource List Routines</span>
<a name="l00035"></a>00035 <span class="comment"> * @ingroup APR_Util</span>
<a name="l00036"></a>00036 <span class="comment"> * @{</span>
<a name="l00037"></a>00037 <span class="comment"> * @warning</span>
<a name="l00038"></a>00038 <span class="comment"> * <strong><em>Resource list data types and routines are only available when</span>
<a name="l00039"></a>00039 <span class="comment"> * threads are enabled (i.e. APR_HAS_THREADS is not zero).</em></strong></span>
<a name="l00040"></a>00040 <span class="comment"> */</span>
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00044"></a>00044 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
<a name="l00045"></a>00045 <span class="comment"></span>
<a name="l00046"></a>00046 <span class="comment">/** Opaque resource list object */</span>
<a name="l00047"></a><a class="code" href="group___a_p_r___util___r_l.html#ga670f6719dfeffe1037e063eaab7b82ac">00047</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group___a_p_r___util___r_l.html#ga670f6719dfeffe1037e063eaab7b82ac">apr_reslist_t</a> <a class="code" href="group___a_p_r___util___r_l.html#ga670f6719dfeffe1037e063eaab7b82ac">apr_reslist_t</a>;
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="comment">/* Generic constructor called by resource list when it needs to create a</span>
<a name="l00050"></a>00050 <span class="comment"> * resource.</span>
<a name="l00051"></a>00051 <span class="comment"> * @param resource opaque resource</span>
<a name="l00052"></a>00052 <span class="comment"> * @param param flags</span>
<a name="l00053"></a>00053 <span class="comment"> * @param pool Pool</span>
<a name="l00054"></a>00054 <span class="comment"> */</span>
<a name="l00055"></a>00055 <span class="keyword">typedef</span> <a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*apr_reslist_constructor)(<span class="keywordtype">void</span> **resource, <span class="keywordtype">void</span> *params,
<a name="l00056"></a>00056 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="comment">/* Generic destructor called by resource list when it needs to destroy a</span>
<a name="l00059"></a>00059 <span class="comment"> * resource.</span>
<a name="l00060"></a>00060 <span class="comment"> * @param resource opaque resource</span>
<a name="l00061"></a>00061 <span class="comment"> * @param param flags</span>
<a name="l00062"></a>00062 <span class="comment"> * @param pool Pool</span>
<a name="l00063"></a>00063 <span class="comment"> */</span>
<a name="l00064"></a>00064 <span class="keyword">typedef</span> <a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a> (*apr_reslist_destructor)(<span class="keywordtype">void</span> *resource, <span class="keywordtype">void</span> *params,
<a name="l00065"></a>00065 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment">/**</span>
<a name="l00068"></a>00068 <span class="comment"> * Create a new resource list with the following parameters:</span>
<a name="l00069"></a>00069 <span class="comment"> * @param reslist An address where the pointer to the new resource</span>
<a name="l00070"></a>00070 <span class="comment"> * list will be stored.</span>
<a name="l00071"></a>00071 <span class="comment"> * @param min Allowed minimum number of available resources. Zero</span>
<a name="l00072"></a>00072 <span class="comment"> * creates new resources only when needed.</span>
<a name="l00073"></a>00073 <span class="comment"> * @param smax Resources will be destroyed during reslist maintenance to</span>
<a name="l00074"></a>00074 <span class="comment"> * meet this maximum restriction as they expire (reach their ttl).</span>
<a name="l00075"></a>00075 <span class="comment"> * @param hmax Absolute maximum limit on the number of total resources.</span>
<a name="l00076"></a>00076 <span class="comment"> * @param ttl If non-zero, sets the maximum amount of time in microseconds an</span>
<a name="l00077"></a>00077 <span class="comment"> * unused resource is valid. Any resource which has exceeded this</span>
<a name="l00078"></a>00078 <span class="comment"> * time will be destroyed, either when encountered by</span>
<a name="l00079"></a>00079 <span class="comment"> * apr_reslist_acquire() or during reslist maintenance.</span>
<a name="l00080"></a>00080 <span class="comment"> * @param con Constructor routine that is called to create a new resource.</span>
<a name="l00081"></a>00081 <span class="comment"> * @param de Destructor routine that is called to destroy an expired resource.</span>
<a name="l00082"></a>00082 <span class="comment"> * @param params Passed to constructor and deconstructor</span>
<a name="l00083"></a>00083 <span class="comment"> * @param pool The pool from which to create this resource list. Also the</span>
<a name="l00084"></a>00084 <span class="comment"> * same pool that is passed to the constructor and destructor</span>
<a name="l00085"></a>00085 <span class="comment"> * routines.</span>
<a name="l00086"></a>00086 <span class="comment"> * @warning If you're creating a sub-pool of the pool passed into this</span>
<a name="l00087"></a>00087 <span class="comment"> * function in your constructor, you will need to follow some rules</span>
<a name="l00088"></a>00088 <span class="comment"> * when it comes to destruction of that sub-pool, as calling</span>
<a name="l00089"></a>00089 <span class="comment"> * apr_pool_destroy() outright on it in your destructor may create</span>
<a name="l00090"></a>00090 <span class="comment"> * double free situations. That is because by the time destructor is</span>
<a name="l00091"></a>00091 <span class="comment"> * called, the sub-pool may have already been destroyed. This also</span>
<a name="l00092"></a>00092 <span class="comment"> * means that in the destructor, memory from the sub-pool should be</span>
<a name="l00093"></a>00093 <span class="comment"> * treated as invalid. For examples of how to do this correctly, see</span>
<a name="l00094"></a>00094 <span class="comment"> * mod_dbd of Apache 2.2 and memcache support in APR Util 1.3.</span>
<a name="l00095"></a>00095 <span class="comment"> */</span>
<a name="l00096"></a>00096 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___r_l.html#ga608ebcddce542603a7f1d3cf51ae8d3c">apr_reslist_create</a>(<a class="code" href="group___a_p_r___util___r_l.html#ga670f6719dfeffe1037e063eaab7b82ac">apr_reslist_t</a> **reslist,
<a name="l00097"></a>00097 <span class="keywordtype">int</span> min, <span class="keywordtype">int</span> smax, <span class="keywordtype">int</span> hmax,
<a name="l00098"></a>00098 <a class="code" href="group__apr__time.html#gaae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> ttl,
<a name="l00099"></a>00099 apr_reslist_constructor con,
<a name="l00100"></a>00100 apr_reslist_destructor de,
<a name="l00101"></a>00101 <span class="keywordtype">void</span> *params,
<a name="l00102"></a>00102 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
<a name="l00103"></a>00103 <span class="comment"></span>
<a name="l00104"></a>00104 <span class="comment">/**</span>
<a name="l00105"></a>00105 <span class="comment"> * Destroy the given resource list and all resources controlled by</span>
<a name="l00106"></a>00106 <span class="comment"> * this list.</span>
<a name="l00107"></a>00107 <span class="comment"> * FIXME: Should this block until all resources become available,</span>
<a name="l00108"></a>00108 <span class="comment"> * or maybe just destroy all the free ones, or maybe destroy</span>
<a name="l00109"></a>00109 <span class="comment"> * them even though they might be in use by something else?</span>
<a name="l00110"></a>00110 <span class="comment"> * Currently it will abort if there are resources that haven't</span>
<a name="l00111"></a>00111 <span class="comment"> * been released, so there is an assumption that all resources</span>
<a name="l00112"></a>00112 <span class="comment"> * have been released to the list before calling this function.</span>
<a name="l00113"></a>00113 <span class="comment"> * @param reslist The reslist to destroy</span>
<a name="l00114"></a>00114 <span class="comment"> */</span>
<a name="l00115"></a>00115 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___r_l.html#ga103e0cbac6c5da7cb93d4e52799233cb">apr_reslist_destroy</a>(<a class="code" href="group___a_p_r___util___r_l.html#ga670f6719dfeffe1037e063eaab7b82ac">apr_reslist_t</a> *reslist);
<a name="l00116"></a>00116 <span class="comment"></span>
<a name="l00117"></a>00117 <span class="comment">/**</span>
<a name="l00118"></a>00118 <span class="comment"> * Retrieve a resource from the list, creating a new one if necessary.</span>
<a name="l00119"></a>00119 <span class="comment"> * If we have met our maximum number of resources, we will block</span>
<a name="l00120"></a>00120 <span class="comment"> * until one becomes available.</span>
<a name="l00121"></a>00121 <span class="comment"> */</span>
<a name="l00122"></a>00122 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___r_l.html#gadfbb592b31ff9215f45d3280636e41d7">apr_reslist_acquire</a>(<a class="code" href="group___a_p_r___util___r_l.html#ga670f6719dfeffe1037e063eaab7b82ac">apr_reslist_t</a> *reslist,
<a name="l00123"></a>00123 <span class="keywordtype">void</span> **resource);
<a name="l00124"></a>00124 <span class="comment"></span>
<a name="l00125"></a>00125 <span class="comment">/**</span>
<a name="l00126"></a>00126 <span class="comment"> * Return a resource back to the list of available resources.</span>
<a name="l00127"></a>00127 <span class="comment"> */</span>
<a name="l00128"></a>00128 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___r_l.html#gaf65ca1701994a0323df639cdb4a8d8b2">apr_reslist_release</a>(<a class="code" href="group___a_p_r___util___r_l.html#ga670f6719dfeffe1037e063eaab7b82ac">apr_reslist_t</a> *reslist,
<a name="l00129"></a>00129 <span class="keywordtype">void</span> *resource);
<a name="l00130"></a>00130 <span class="comment"></span>
<a name="l00131"></a>00131 <span class="comment">/**</span>
<a name="l00132"></a>00132 <span class="comment"> * Set the timeout the acquire will wait for a free resource</span>
<a name="l00133"></a>00133 <span class="comment"> * when the maximum number of resources is exceeded.</span>
<a name="l00134"></a>00134 <span class="comment"> * @param reslist The resource list.</span>
<a name="l00135"></a>00135 <span class="comment"> * @param timeout Timeout to wait. The zero waits forever.</span>
<a name="l00136"></a>00136 <span class="comment"> */</span>
<a name="l00137"></a>00137 APU_DECLARE(<span class="keywordtype">void</span>) <a class="code" href="group___a_p_r___util___r_l.html#gafe06c964d04a568f2625fb5a9ba7bad6">apr_reslist_timeout_set</a>(<a class="code" href="group___a_p_r___util___r_l.html#ga670f6719dfeffe1037e063eaab7b82ac">apr_reslist_t</a> *reslist,
<a name="l00138"></a>00138 <a class="code" href="group__apr__time.html#gaae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> timeout);
<a name="l00139"></a>00139 <span class="comment"></span>
<a name="l00140"></a>00140 <span class="comment">/**</span>
<a name="l00141"></a>00141 <span class="comment"> * Return the number of outstanding resources.</span>
<a name="l00142"></a>00142 <span class="comment"> * @param reslist The resource list.</span>
<a name="l00143"></a>00143 <span class="comment"> */</span>
<a name="l00144"></a>00144 APU_DECLARE(apr_uint32_t) <a class="code" href="group___a_p_r___util___r_l.html#gac37fbbcbc8a98ba9ed017638a2c6c1b7">apr_reslist_acquired_count</a>(<a class="code" href="group___a_p_r___util___r_l.html#ga670f6719dfeffe1037e063eaab7b82ac">apr_reslist_t</a> *reslist);
<a name="l00145"></a>00145 <span class="comment"></span>
<a name="l00146"></a>00146 <span class="comment">/**</span>
<a name="l00147"></a>00147 <span class="comment"> * Invalidate a resource in the pool - e.g. a database connection</span>
<a name="l00148"></a>00148 <span class="comment"> * that returns a "lost connection" error and can't be restored.</span>
<a name="l00149"></a>00149 <span class="comment"> * Use this instead of apr_reslist_release if the resource is bad.</span>
<a name="l00150"></a>00150 <span class="comment"> */</span>
<a name="l00151"></a>00151 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___r_l.html#ga346c0604115a9659cf23ed0cc781f7a9">apr_reslist_invalidate</a>(<a class="code" href="group___a_p_r___util___r_l.html#ga670f6719dfeffe1037e063eaab7b82ac">apr_reslist_t</a> *reslist,
<a name="l00152"></a>00152 <span class="keywordtype">void</span> *resource);
<a name="l00153"></a>00153
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00156"></a>00156 <span class="preprocessor"></span>}
<a name="l00157"></a>00157 <span class="preprocessor">#endif</span>
<a name="l00158"></a>00158 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00159"></a>00159 <span class="comment">/** @} */</span>
<a name="l00160"></a>00160
<a name="l00161"></a>00161 <span class="preprocessor">#endif </span><span class="comment">/* APR_HAS_THREADS */</span>
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="preprocessor">#endif </span><span class="comment">/* ! APR_RESLIST_H */</span>
</pre></div></div>
</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 class="footer"><small>Generated on Tue Feb 8 2011 for Apache Portable Runtime by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address>
</body>
</html>
