<!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_thread_pool.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_thread_pool.h</h1> </div>
</div>
<div class="contents">
<a href="apr__thread__pool_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span>
<a name="l00003"></a>00003 <span class="comment"> * contributor license agreements. See the NOTICE file distributed</span>
<a name="l00004"></a>00004 <span class="comment"> * with this work for additional information regarding copyright</span>
<a name="l00005"></a>00005 <span class="comment"> * ownership. The ASF licenses this file to you under the Apache</span>
<a name="l00006"></a>00006 <span class="comment"> * License, Version 2.0 (the "License"); you may not use this file</span>
<a name="l00007"></a>00007 <span class="comment"> * except in compliance with the License. You may obtain a copy of</span>
<a name="l00008"></a>00008 <span class="comment"> * the License at</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00013"></a>00013 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00014"></a>00014 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or</span>
<a name="l00015"></a>00015 <span class="comment"> * implied. See the License for the specific language governing</span>
<a name="l00016"></a>00016 <span class="comment"> * permissions and limitations under the License.</span>
<a name="l00017"></a>00017 <span class="comment"> */</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef APU_THREAD_POOL_H</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define APU_THREAD_POOL_H</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include "apu.h"</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="apr__thread__proc_8h.html" title="APR Thread and Process Library.">apr_thread_proc.h</a>"</span>
<a name="l00024"></a>00024 <span class="comment"></span>
<a name="l00025"></a>00025 <span class="comment">/**</span>
<a name="l00026"></a>00026 <span class="comment"> * @file apr_thread_pool.h</span>
<a name="l00027"></a>00027 <span class="comment"> * @brief APR Thread Pool Library</span>
<a name="l00028"></a>00028 <span class="comment"></span>
<a name="l00029"></a>00029 <span class="comment"> * @remarks This library implements a thread pool using apr_thread_t. A thread</span>
<a name="l00030"></a>00030 <span class="comment"> * pool is a set of threads that can be created in advance or on demand until a</span>
<a name="l00031"></a>00031 <span class="comment"> * maximum number. When a task is scheduled, the thread pool will find an idle</span>
<a name="l00032"></a>00032 <span class="comment"> * thread to handle the task. In case all existing threads are busy and the</span>
<a name="l00033"></a>00033 <span class="comment"> * number of tasks in the queue is higher than the adjustable threshold, the</span>
<a name="l00034"></a>00034 <span class="comment"> * pool will try to create a new thread to serve the task if the maximum number</span>
<a name="l00035"></a>00035 <span class="comment"> * has not been reached. Otherwise, the task will be put into a queue based on</span>
<a name="l00036"></a>00036 <span class="comment"> * priority, which can be valued from 0 to 255, with higher values being served</span>
<a name="l00037"></a>00037 <span class="comment"> * first. If there are tasks with the same priority, the new task might be put at</span>
<a name="l00038"></a>00038 <span class="comment"> * the top or at the bottom - it depends on which function is used to put the task.</span>
<a name="l00039"></a>00039 <span class="comment"> *</span>
<a name="l00040"></a>00040 <span class="comment"> * @remarks There may be the case where the thread pool can use up to the maximum</span>
<a name="l00041"></a>00041 <span class="comment"> * number of threads at peak load, but having those threads idle afterwards. A</span>
<a name="l00042"></a>00042 <span class="comment"> * maximum number of idle threads can be set so that the extra idling threads will</span>
<a name="l00043"></a>00043 <span class="comment"> * be terminated to save system resources.</span>
<a name="l00044"></a>00044 <span class="comment"> */</span>
<a name="l00045"></a>00045 <span class="preprocessor">#if APR_HAS_THREADS</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span>
<a name="l00047"></a>00047 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00049"></a>00049 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment">/**</span>
<a name="l00052"></a>00052 <span class="comment"> * @defgroup APR_Util_TP Thread Pool routines</span>
<a name="l00053"></a>00053 <span class="comment"> * @ingroup APR_Util</span>
<a name="l00054"></a>00054 <span class="comment"> * @{</span>
<a name="l00055"></a>00055 <span class="comment"> */</span>
<a name="l00056"></a>00056 <span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment">/** Opaque Thread Pool structure. */</span>
<a name="l00058"></a><a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">00058</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>apr_thread_pool <a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a>;
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="preprocessor">#define APR_THREAD_TASK_PRIORITY_LOWEST 0</span>
<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="preprocessor">#define APR_THREAD_TASK_PRIORITY_LOW 63</span>
<a name="l00062"></a>00062 <span class="preprocessor"></span><span class="preprocessor">#define APR_THREAD_TASK_PRIORITY_NORMAL 127</span>
<a name="l00063"></a>00063 <span class="preprocessor"></span><span class="preprocessor">#define APR_THREAD_TASK_PRIORITY_HIGH 191</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="preprocessor">#define APR_THREAD_TASK_PRIORITY_HIGHEST 255</span>
<a name="l00065"></a>00065 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00066"></a>00066 <span class="comment">/**</span>
<a name="l00067"></a>00067 <span class="comment"> * Create a thread pool</span>
<a name="l00068"></a>00068 <span class="comment"> * @param me The pointer in which to return the newly created apr_thread_pool</span>
<a name="l00069"></a>00069 <span class="comment"> * object, or NULL if thread pool creation fails.</span>
<a name="l00070"></a>00070 <span class="comment"> * @param init_threads The number of threads to be created initially, this number</span>
<a name="l00071"></a>00071 <span class="comment"> * will also be used as the initial value for the maximum number of idle threads.</span>
<a name="l00072"></a>00072 <span class="comment"> * @param max_threads The maximum number of threads that can be created</span>
<a name="l00073"></a>00073 <span class="comment"> * @param pool The pool to use</span>
<a name="l00074"></a>00074 <span class="comment"> * @return APR_SUCCESS if the thread pool was created successfully. Otherwise,</span>
<a name="l00075"></a>00075 <span class="comment"> * the error code.</span>
<a name="l00076"></a>00076 <span class="comment"> */</span>
<a name="l00077"></a>00077 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___t_p.html#ga9c4351f2f93d223c159c1f8e5481830e">apr_thread_pool_create</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> **me,
<a name="l00078"></a>00078 apr_size_t init_threads,
<a name="l00079"></a>00079 apr_size_t max_threads,
<a name="l00080"></a>00080 <a class="code" href="group__apr__pools.html#gaf137f28edcf9a086cd6bc36c20d7cdfb">apr_pool_t</a> *pool);
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment">/**</span>
<a name="l00083"></a>00083 <span class="comment"> * Destroy the thread pool and stop all the threads</span>
<a name="l00084"></a>00084 <span class="comment"> * @return APR_SUCCESS if all threads are stopped.</span>
<a name="l00085"></a>00085 <span class="comment"> */</span>
<a name="l00086"></a>00086 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___t_p.html#gab06b4fdfc684c88781abf201d53a44eb">apr_thread_pool_destroy</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me);
<a name="l00087"></a>00087 <span class="comment"></span>
<a name="l00088"></a>00088 <span class="comment">/**</span>
<a name="l00089"></a>00089 <span class="comment"> * Schedule a task to the bottom of the tasks of same priority.</span>
<a name="l00090"></a>00090 <span class="comment"> * @param me The thread pool</span>
<a name="l00091"></a>00091 <span class="comment"> * @param func The task function</span>
<a name="l00092"></a>00092 <span class="comment"> * @param param The parameter for the task function</span>
<a name="l00093"></a>00093 <span class="comment"> * @param priority The priority of the task.</span>
<a name="l00094"></a>00094 <span class="comment"> * @param owner Owner of this task.</span>
<a name="l00095"></a>00095 <span class="comment"> * @return APR_SUCCESS if the task had been scheduled successfully</span>
<a name="l00096"></a>00096 <span class="comment"> */</span>
<a name="l00097"></a>00097 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___t_p.html#gad66fb92679a8f456ff8e8ea1629eb041">apr_thread_pool_push</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me,
<a name="l00098"></a>00098 <a class="code" href="group__apr__thread__proc.html#ga37193850d158ca870fc8f8759f0725a9">apr_thread_start_t</a> func,
<a name="l00099"></a>00099 <span class="keywordtype">void</span> *param,
<a name="l00100"></a>00100 apr_byte_t priority,
<a name="l00101"></a>00101 <span class="keywordtype">void</span> *owner);<span class="comment"></span>
<a name="l00102"></a>00102 <span class="comment">/**</span>
<a name="l00103"></a>00103 <span class="comment"> * Schedule a task to be run after a delay</span>
<a name="l00104"></a>00104 <span class="comment"> * @param me The thread pool</span>
<a name="l00105"></a>00105 <span class="comment"> * @param func The task function</span>
<a name="l00106"></a>00106 <span class="comment"> * @param param The parameter for the task function</span>
<a name="l00107"></a>00107 <span class="comment"> * @param time Time in microseconds</span>
<a name="l00108"></a>00108 <span class="comment"> * @param owner Owner of this task.</span>
<a name="l00109"></a>00109 <span class="comment"> * @return APR_SUCCESS if the task had been scheduled successfully</span>
<a name="l00110"></a>00110 <span class="comment"> */</span>
<a name="l00111"></a>00111 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___t_p.html#gaa79df50c650442b8d39e169f4e422d3b">apr_thread_pool_schedule</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me,
<a name="l00112"></a>00112 <a class="code" href="group__apr__thread__proc.html#ga37193850d158ca870fc8f8759f0725a9">apr_thread_start_t</a> func,
<a name="l00113"></a>00113 <span class="keywordtype">void</span> *param,
<a name="l00114"></a>00114 <a class="code" href="group__apr__time.html#gaae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> time,
<a name="l00115"></a>00115 <span class="keywordtype">void</span> *owner);
<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"> * Schedule a task to the top of the tasks of same priority.</span>
<a name="l00119"></a>00119 <span class="comment"> * @param me The thread pool</span>
<a name="l00120"></a>00120 <span class="comment"> * @param func The task function</span>
<a name="l00121"></a>00121 <span class="comment"> * @param param The parameter for the task function</span>
<a name="l00122"></a>00122 <span class="comment"> * @param priority The priority of the task.</span>
<a name="l00123"></a>00123 <span class="comment"> * @param owner Owner of this task.</span>
<a name="l00124"></a>00124 <span class="comment"> * @return APR_SUCCESS if the task had been scheduled successfully</span>
<a name="l00125"></a>00125 <span class="comment"> */</span>
<a name="l00126"></a>00126 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___t_p.html#ga9acb6218820184f0617eecf56f0d3d84">apr_thread_pool_top</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me,
<a name="l00127"></a>00127 <a class="code" href="group__apr__thread__proc.html#ga37193850d158ca870fc8f8759f0725a9">apr_thread_start_t</a> func,
<a name="l00128"></a>00128 <span class="keywordtype">void</span> *param,
<a name="l00129"></a>00129 apr_byte_t priority,
<a name="l00130"></a>00130 <span class="keywordtype">void</span> *owner);
<a name="l00131"></a>00131 <span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment">/**</span>
<a name="l00133"></a>00133 <span class="comment"> * Cancel tasks submitted by the owner. If there is any task from the owner that</span>
<a name="l00134"></a>00134 <span class="comment"> * is currently running, the function will spin until the task finished.</span>
<a name="l00135"></a>00135 <span class="comment"> * @param me The thread pool</span>
<a name="l00136"></a>00136 <span class="comment"> * @param owner Owner of the task</span>
<a name="l00137"></a>00137 <span class="comment"> * @return APR_SUCCESS if the task has been cancelled successfully</span>
<a name="l00138"></a>00138 <span class="comment"> * @note The task function should not be calling cancel, otherwise the function</span>
<a name="l00139"></a>00139 <span class="comment"> * may get stuck forever. The function assert if it detect such a case.</span>
<a name="l00140"></a>00140 <span class="comment"> */</span>
<a name="l00141"></a>00141 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___t_p.html#gaee3d7332cf2591f42472e8be0bcbff87">apr_thread_pool_tasks_cancel</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me,
<a name="l00142"></a>00142 <span class="keywordtype">void</span> *owner);
<a name="l00143"></a>00143 <span class="comment"></span>
<a name="l00144"></a>00144 <span class="comment">/**</span>
<a name="l00145"></a>00145 <span class="comment"> * Get the current number of tasks waiting in the queue</span>
<a name="l00146"></a>00146 <span class="comment"> * @param me The thread pool</span>
<a name="l00147"></a>00147 <span class="comment"> * @return Number of tasks in the queue</span>
<a name="l00148"></a>00148 <span class="comment"> */</span>
<a name="l00149"></a>00149 APU_DECLARE(apr_size_t) <a class="code" href="group___a_p_r___util___t_p.html#ga4f628cbec0365bb39be715a3c7ff0ec3">apr_thread_pool_tasks_count</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me);
<a name="l00150"></a>00150 <span class="comment"></span>
<a name="l00151"></a>00151 <span class="comment">/**</span>
<a name="l00152"></a>00152 <span class="comment"> * Get the current number of scheduled tasks waiting in the queue</span>
<a name="l00153"></a>00153 <span class="comment"> * @param me The thread pool</span>
<a name="l00154"></a>00154 <span class="comment"> * @return Number of scheduled tasks in the queue</span>
<a name="l00155"></a>00155 <span class="comment"> */</span>
<a name="l00156"></a>00156 APU_DECLARE(apr_size_t) <a class="code" href="group___a_p_r___util___t_p.html#gac0324b95f6b61dbfb184cbe84c541b42">apr_thread_pool_scheduled_tasks_count</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me);
<a name="l00157"></a>00157 <span class="comment"></span>
<a name="l00158"></a>00158 <span class="comment">/**</span>
<a name="l00159"></a>00159 <span class="comment"> * Get the current number of threads</span>
<a name="l00160"></a>00160 <span class="comment"> * @param me The thread pool</span>
<a name="l00161"></a>00161 <span class="comment"> * @return Total number of threads</span>
<a name="l00162"></a>00162 <span class="comment"> */</span>
<a name="l00163"></a>00163 APU_DECLARE(apr_size_t) <a class="code" href="group___a_p_r___util___t_p.html#ga9a2642a5a61df9560da438e818d5fad3">apr_thread_pool_threads_count</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me);
<a name="l00164"></a>00164 <span class="comment"></span>
<a name="l00165"></a>00165 <span class="comment">/**</span>
<a name="l00166"></a>00166 <span class="comment"> * Get the current number of busy threads</span>
<a name="l00167"></a>00167 <span class="comment"> * @param me The thread pool</span>
<a name="l00168"></a>00168 <span class="comment"> * @return Number of busy threads</span>
<a name="l00169"></a>00169 <span class="comment"> */</span>
<a name="l00170"></a>00170 APU_DECLARE(apr_size_t) <a class="code" href="group___a_p_r___util___t_p.html#gaf839cda931928964f450e3a17d153b24">apr_thread_pool_busy_count</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me);
<a name="l00171"></a>00171 <span class="comment"></span>
<a name="l00172"></a>00172 <span class="comment">/**</span>
<a name="l00173"></a>00173 <span class="comment"> * Get the current number of idle threads</span>
<a name="l00174"></a>00174 <span class="comment"> * @param me The thread pool</span>
<a name="l00175"></a>00175 <span class="comment"> * @return Number of idle threads</span>
<a name="l00176"></a>00176 <span class="comment"> */</span>
<a name="l00177"></a>00177 APU_DECLARE(apr_size_t) <a class="code" href="group___a_p_r___util___t_p.html#gae6c5b87d1fee7150f74baa1008cb00c0">apr_thread_pool_idle_count</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me);
<a name="l00178"></a>00178 <span class="comment"></span>
<a name="l00179"></a>00179 <span class="comment">/**</span>
<a name="l00180"></a>00180 <span class="comment"> * Access function for the maximum number of idle threads. Number of current</span>
<a name="l00181"></a>00181 <span class="comment"> * idle threads will be reduced to the new limit.</span>
<a name="l00182"></a>00182 <span class="comment"> * @param me The thread pool</span>
<a name="l00183"></a>00183 <span class="comment"> * @param cnt The number</span>
<a name="l00184"></a>00184 <span class="comment"> * @return The number of threads that were stopped.</span>
<a name="l00185"></a>00185 <span class="comment"> */</span>
<a name="l00186"></a>00186 APU_DECLARE(apr_size_t) <a class="code" href="group___a_p_r___util___t_p.html#ga07c5e4dca589ff024e9adfc8f818c481">apr_thread_pool_idle_max_set</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me,
<a name="l00187"></a>00187 apr_size_t cnt);
<a name="l00188"></a>00188 <span class="comment"></span>
<a name="l00189"></a>00189 <span class="comment">/**</span>
<a name="l00190"></a>00190 <span class="comment"> * Get number of tasks that have run</span>
<a name="l00191"></a>00191 <span class="comment"> * @param me The thread pool</span>
<a name="l00192"></a>00192 <span class="comment"> * @return Number of tasks that have run</span>
<a name="l00193"></a>00193 <span class="comment"> */</span>
<a name="l00194"></a>00194 APU_DECLARE(apr_size_t)
<a name="l00195"></a>00195 <a class="code" href="group___a_p_r___util___t_p.html#gaab5c9c8afc46793ea5c413edfc9ef46e">apr_thread_pool_tasks_run_count</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> * me);
<a name="l00196"></a>00196 <span class="comment"></span>
<a name="l00197"></a>00197 <span class="comment">/**</span>
<a name="l00198"></a>00198 <span class="comment"> * Get high water mark of the number of tasks waiting to run</span>
<a name="l00199"></a>00199 <span class="comment"> * @param me The thread pool</span>
<a name="l00200"></a>00200 <span class="comment"> * @return High water mark of tasks waiting to run</span>
<a name="l00201"></a>00201 <span class="comment"> */</span>
<a name="l00202"></a>00202 APU_DECLARE(apr_size_t)
<a name="l00203"></a>00203 <a class="code" href="group___a_p_r___util___t_p.html#ga5eda07fb7fac1b4c4165137f34c5c31c">apr_thread_pool_tasks_high_count</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> * me);
<a name="l00204"></a>00204 <span class="comment"></span>
<a name="l00205"></a>00205 <span class="comment">/**</span>
<a name="l00206"></a>00206 <span class="comment"> * Get high water mark of the number of threads</span>
<a name="l00207"></a>00207 <span class="comment"> * @param me The thread pool</span>
<a name="l00208"></a>00208 <span class="comment"> * @return High water mark of threads in thread pool</span>
<a name="l00209"></a>00209 <span class="comment"> */</span>
<a name="l00210"></a>00210 APU_DECLARE(apr_size_t)
<a name="l00211"></a>00211 <a class="code" href="group___a_p_r___util___t_p.html#gab6dcdaa6129caf35fa370e694a67ff08">apr_thread_pool_threads_high_count</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> * me);
<a name="l00212"></a>00212 <span class="comment"></span>
<a name="l00213"></a>00213 <span class="comment">/**</span>
<a name="l00214"></a>00214 <span class="comment"> * Get the number of idle threads that were destroyed after timing out</span>
<a name="l00215"></a>00215 <span class="comment"> * @param me The thread pool</span>
<a name="l00216"></a>00216 <span class="comment"> * @return Number of idle threads that timed out</span>
<a name="l00217"></a>00217 <span class="comment"> */</span>
<a name="l00218"></a>00218 APU_DECLARE(apr_size_t)
<a name="l00219"></a>00219 <a class="code" href="group___a_p_r___util___t_p.html#gafcf0a761a77b2a27fc043d650606c122">apr_thread_pool_threads_idle_timeout_count</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> * me);
<a name="l00220"></a>00220 <span class="comment"></span>
<a name="l00221"></a>00221 <span class="comment">/**</span>
<a name="l00222"></a>00222 <span class="comment"> * Access function for the maximum number of idle threads</span>
<a name="l00223"></a>00223 <span class="comment"> * @param me The thread pool</span>
<a name="l00224"></a>00224 <span class="comment"> * @return The current maximum number</span>
<a name="l00225"></a>00225 <span class="comment"> */</span>
<a name="l00226"></a>00226 APU_DECLARE(apr_size_t) <a class="code" href="group___a_p_r___util___t_p.html#ga6dd7fdcaac5cb2848aecd2ee1426d41e">apr_thread_pool_idle_max_get</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me);
<a name="l00227"></a>00227 <span class="comment"></span>
<a name="l00228"></a>00228 <span class="comment">/**</span>
<a name="l00229"></a>00229 <span class="comment"> * Access function for the maximum number of threads.</span>
<a name="l00230"></a>00230 <span class="comment"> * @param me The thread pool</span>
<a name="l00231"></a>00231 <span class="comment"> * @param cnt Number of threads</span>
<a name="l00232"></a>00232 <span class="comment"> * @return The original maximum number of threads</span>
<a name="l00233"></a>00233 <span class="comment"> */</span>
<a name="l00234"></a>00234 APU_DECLARE(apr_size_t) <a class="code" href="group___a_p_r___util___t_p.html#gaa352b6337b31ebab796b604240a907e9">apr_thread_pool_thread_max_set</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me,
<a name="l00235"></a>00235 apr_size_t cnt);
<a name="l00236"></a>00236 <span class="comment"></span>
<a name="l00237"></a>00237 <span class="comment">/**</span>
<a name="l00238"></a>00238 <span class="comment"> * Access function for the maximum wait time (in microseconds) of an</span>
<a name="l00239"></a>00239 <span class="comment"> * idling thread that exceeds the maximum number of idling threads.</span>
<a name="l00240"></a>00240 <span class="comment"> * A non-zero value allows for the reaping of idling threads to shrink</span>
<a name="l00241"></a>00241 <span class="comment"> * over time. Which helps reduce thrashing.</span>
<a name="l00242"></a>00242 <span class="comment"> * @param me The thread pool</span>
<a name="l00243"></a>00243 <span class="comment"> * @param timeout The number of microseconds an idle thread should wait</span>
<a name="l00244"></a>00244 <span class="comment"> * till it reaps itself</span>
<a name="l00245"></a>00245 <span class="comment"> * @return The original maximum wait time</span>
<a name="l00246"></a>00246 <span class="comment"> */</span>
<a name="l00247"></a>00247 APU_DECLARE(<a class="code" href="group__apr__time.html#gaae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a>)
<a name="l00248"></a>00248 <a class="code" href="group___a_p_r___util___t_p.html#ga382b90c482d39184b2a80157f64166ec">apr_thread_pool_idle_wait_set</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> * me,
<a name="l00249"></a>00249 <a class="code" href="group__apr__time.html#gaae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a> timeout);
<a name="l00250"></a>00250 <span class="comment"></span>
<a name="l00251"></a>00251 <span class="comment">/**</span>
<a name="l00252"></a>00252 <span class="comment"> * Access function for the maximum wait time (in microseconds) of an</span>
<a name="l00253"></a>00253 <span class="comment"> * idling thread that exceeds the maximum number of idling threads</span>
<a name="l00254"></a>00254 <span class="comment"> * @param me The thread pool</span>
<a name="l00255"></a>00255 <span class="comment"> * @return The current maximum wait time</span>
<a name="l00256"></a>00256 <span class="comment"> */</span>
<a name="l00257"></a>00257 APU_DECLARE(<a class="code" href="group__apr__time.html#gaae2129185a395cc393f76fabf4f43e47">apr_interval_time_t</a>)
<a name="l00258"></a>00258 <a class="code" href="group___a_p_r___util___t_p.html#ga6ef255c2d556fa757e9b78c2745c9bac">apr_thread_pool_idle_wait_get</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> * me);
<a name="l00259"></a>00259 <span class="comment"></span>
<a name="l00260"></a>00260 <span class="comment">/**</span>
<a name="l00261"></a>00261 <span class="comment"> * Access function for the maximum number of threads</span>
<a name="l00262"></a>00262 <span class="comment"> * @param me The thread pool</span>
<a name="l00263"></a>00263 <span class="comment"> * @return The current maximum number</span>
<a name="l00264"></a>00264 <span class="comment"> */</span>
<a name="l00265"></a>00265 APU_DECLARE(apr_size_t) <a class="code" href="group___a_p_r___util___t_p.html#gaca755ea05976c5e1b782dcf40a1ef443">apr_thread_pool_thread_max_get</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me);
<a name="l00266"></a>00266 <span class="comment"></span>
<a name="l00267"></a>00267 <span class="comment">/**</span>
<a name="l00268"></a>00268 <span class="comment"> * Access function for the threshold of tasks in queue to trigger a new thread.</span>
<a name="l00269"></a>00269 <span class="comment"> * @param me The thread pool</span>
<a name="l00270"></a>00270 <span class="comment"> * @param cnt The new threshold</span>
<a name="l00271"></a>00271 <span class="comment"> * @return The original threshold</span>
<a name="l00272"></a>00272 <span class="comment"> */</span>
<a name="l00273"></a>00273 APU_DECLARE(apr_size_t) <a class="code" href="group___a_p_r___util___t_p.html#ga1c35f1bd809dde4300f4a3f77026f446">apr_thread_pool_threshold_set</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> *me,
<a name="l00274"></a>00274 apr_size_t val);
<a name="l00275"></a>00275 <span class="comment"></span>
<a name="l00276"></a>00276 <span class="comment">/**</span>
<a name="l00277"></a>00277 <span class="comment"> * Access function for the threshold of tasks in queue to trigger a new thread.</span>
<a name="l00278"></a>00278 <span class="comment"> * @param me The thread pool</span>
<a name="l00279"></a>00279 <span class="comment"> * @return The current threshold</span>
<a name="l00280"></a>00280 <span class="comment"> */</span>
<a name="l00281"></a>00281 APU_DECLARE(apr_size_t) <a class="code" href="group___a_p_r___util___t_p.html#ga38f4ad8e384cde0e9d32867031c7a935">apr_thread_pool_threshold_get</a>(<a class="code" href="group___a_p_r___util___t_p.html#gab31b68a03a0d5eec3e1879c253d3b620">apr_thread_pool_t</a> * me);
<a name="l00282"></a>00282 <span class="comment"></span>
<a name="l00283"></a>00283 <span class="comment">/**</span>
<a name="l00284"></a>00284 <span class="comment"> * Get owner of the task currently been executed by the thread.</span>
<a name="l00285"></a>00285 <span class="comment"> * @param thd The thread is executing a task</span>
<a name="l00286"></a>00286 <span class="comment"> * @param owner Pointer to receive owner of the task.</span>
<a name="l00287"></a>00287 <span class="comment"> * @return APR_SUCCESS if the owner is retrieved successfully</span>
<a name="l00288"></a>00288 <span class="comment"> */</span>
<a name="l00289"></a>00289 APU_DECLARE(<a class="code" href="group__apr__errno.html#gaf76ee4543247e9fb3f3546203e590a6c">apr_status_t</a>) <a class="code" href="group___a_p_r___util___t_p.html#gaefbaa0f765567e8e5a79adaaf346755f">apr_thread_pool_task_owner_get</a>(<a class="code" href="group__apr__thread__proc.html#ga646c71351e723d84f8cc8c8d1d5937be">apr_thread_t</a> *thd,
<a name="l00290"></a>00290 <span class="keywordtype">void</span> **owner);
<a name="l00291"></a>00291 <span class="comment"></span>
<a name="l00292"></a>00292 <span class="comment">/** @} */</span>
<a name="l00293"></a>00293
<a name="l00294"></a>00294 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00295"></a>00295 <span class="preprocessor"></span>}
<a name="l00296"></a>00296 <span class="preprocessor">#endif</span>
<a name="l00297"></a>00297 <span class="preprocessor"></span>
<a name="l00298"></a>00298 <span class="preprocessor">#endif </span><span class="comment">/* APR_HAS_THREADS */</span>
<a name="l00299"></a>00299 <span class="preprocessor">#endif </span><span class="comment">/* !APR_THREAD_POOL_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>
