You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@apr.apache.org by je...@apache.org on 2005/02/08 00:12:22 UTC
svn commit: r151768 [36/47] - in apr/site/trunk/docs/docs/apr: ./ iconv/
util/
Modified: apr/site/trunk/docs/docs/apr/apr__thread__cond_8h-source.html
URL: http://svn.apache.org/viewcvs/apr/site/trunk/docs/docs/apr/apr__thread__cond_8h-source.html?view=diff&r1=151767&r2=151768
==============================================================================
--- apr/site/trunk/docs/docs/apr/apr__thread__cond_8h-source.html (original)
+++ apr/site/trunk/docs/docs/apr/apr__thread__cond_8h-source.html Mon Feb 7 15:10:17 2005
@@ -3,143 +3,144 @@
<title>Apache Portable Runtime: apr_thread_cond.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
-<!-- Generated by Doxygen 1.3.8 -->
+<!-- Generated by Doxygen 1.3.7 -->
<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>apr_thread_cond.h</h1><a href="apr__thread__cond_8h.html">Go to the documentation of this file.</a><pre class="fragment"><div>00001 <span class="comment">/* Copyright 2000-2004 The Apache Software Foundation</span>
-00002 <span class="comment"> *</span>
-00003 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span>
-00004 <span class="comment"> * you may not use this file except in compliance with the License.</span>
-00005 <span class="comment"> * You may obtain a copy of the License at</span>
-00006 <span class="comment"> *</span>
-00007 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
-00008 <span class="comment"> *</span>
-00009 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
-00010 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
-00011 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
-00012 <span class="comment"> * See the License for the specific language governing permissions and</span>
-00013 <span class="comment"> * limitations under the License.</span>
-00014 <span class="comment"> */</span>
-00015
-00016 <span class="preprocessor">#ifndef APR_THREAD_COND_H</span>
-00017 <span class="preprocessor"></span><span class="preprocessor">#define APR_THREAD_COND_H</span>
-00018 <span class="preprocessor"></span><span class="comment"></span>
-00019 <span class="comment">/**</span>
-00020 <span class="comment"> * @file apr_thread_cond.h</span>
-00021 <span class="comment"> * @brief APR Condition Variable Routines</span>
-00022 <span class="comment"> */</span>
-00023
-00024 <span class="preprocessor">#include "apr.h"</span>
-00025 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html">apr_pools.h</a>"</span>
-00026 <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html">apr_errno.h</a>"</span>
-00027 <span class="preprocessor">#include "<a class="code" href="apr__time_8h.html">apr_time.h</a>"</span>
-00028 <span class="preprocessor">#include "<a class="code" href="apr__thread__mutex_8h.html">apr_thread_mutex.h</a>"</span>
-00029
-00030 <span class="preprocessor">#ifdef __cplusplus</span>
-00031 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
-00032 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
-00033
-00034 <span class="preprocessor">#if APR_HAS_THREADS || defined(DOXYGEN)</span>
-00035 <span class="preprocessor"></span><span class="comment"></span>
-00036 <span class="comment">/**</span>
-00037 <span class="comment"> * @defgroup apr_thread_cond Condition Variable Routines</span>
-00038 <span class="comment"> * @ingroup APR </span>
-00039 <span class="comment"> * @{</span>
-00040 <span class="comment"> */</span>
-00041 <span class="comment"></span>
-00042 <span class="comment">/** Opaque structure for thread condition variables */</span>
-<a name="l00043"></a><a class="code" href="group__apr__thread__cond.html#ga0">00043</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__apr__thread__cond.html#ga0">apr_thread_cond_t</a> <a class="code" href="group__apr__thread__cond.html#ga0">apr_thread_cond_t</a>;
-00044 <span class="comment"></span>
-00045 <span class="comment">/**</span>
-00046 <span class="comment"> * Note: destroying a condition variable (or likewise, destroying or</span>
-00047 <span class="comment"> * clearing the pool from which a condition variable was allocated) if</span>
-00048 <span class="comment"> * any threads are blocked waiting on it gives undefined results.</span>
-00049 <span class="comment"> */</span>
-00050 <span class="comment"></span>
-00051 <span class="comment">/**</span>
-00052 <span class="comment"> * Create and initialize a condition variable that can be used to signal</span>
-00053 <span class="comment"> * and schedule threads in a single process.</span>
-00054 <span class="comment"> * @param cond the memory address where the newly created condition variable</span>
-00055 <span class="comment"> * will be stored.</span>
-00056 <span class="comment"> * @param pool the pool from which to allocate the mutex.</span>
-00057 <span class="comment"> */</span>
-00058 APR_DECLARE(<a class="code" href="group__apr__errno.html#ga0">apr_status_t</a>) apr_thread_cond_create(apr_thread_cond_t **cond,
-00059 <a class="code" href="group__apr__pools.html#ga0">apr_pool_t</a> *pool);
-00060 <span class="comment"></span>
-00061 <span class="comment">/**</span>
-00062 <span class="comment"> * Put the active calling thread to sleep until signaled to wake up. Each</span>
-00063 <span class="comment"> * condition variable must be associated with a mutex, and that mutex must</span>
-00064 <span class="comment"> * be locked before calling this function, or the behavior will be</span>
-00065 <span class="comment"> * undefined. As the calling thread is put to sleep, the given mutex</span>
-00066 <span class="comment"> * will be simultaneously released; and as this thread wakes up the lock</span>
-00067 <span class="comment"> * is again simultaneously acquired.</span>
-00068 <span class="comment"> * @param cond the condition variable on which to block.</span>
-00069 <span class="comment"> * @param mutex the mutex that must be locked upon entering this function,</span>
-00070 <span class="comment"> * is released while the thread is asleep, and is again acquired before</span>
-00071 <span class="comment"> * returning from this function.</span>
-00072 <span class="comment"> */</span>
-00073 APR_DECLARE(<a class="code" href="group__apr__errno.html#ga0">apr_status_t</a>) apr_thread_cond_wait(apr_thread_cond_t *cond,
-00074 <a class="code" href="group__apr__thread__mutex.html#ga0">apr_thread_mutex_t</a> *mutex);
-00075 <span class="comment"></span>
-00076 <span class="comment">/**</span>
-00077 <span class="comment"> * Put the active calling thread to sleep until signaled to wake up or</span>
-00078 <span class="comment"> * the timeout is reached. Each condition variable must be associated</span>
-00079 <span class="comment"> * with a mutex, and that mutex must be locked before calling this</span>
-00080 <span class="comment"> * function, or the behavior will be undefined. As the calling thread</span>
-00081 <span class="comment"> * is put to sleep, the given mutex will be simultaneously released;</span>
-00082 <span class="comment"> * and as this thread wakes up the lock is again simultaneously acquired.</span>
-00083 <span class="comment"> * @param cond the condition variable on which to block.</span>
-00084 <span class="comment"> * @param mutex the mutex that must be locked upon entering this function,</span>
-00085 <span class="comment"> * is released while the thread is asleep, and is again acquired before</span>
-00086 <span class="comment"> * returning from this function.</span>
-00087 <span class="comment"> * @param timeout The amount of time in microseconds to wait. This is </span>
-00088 <span class="comment"> * a maximum, not a minimum. If the condition is signaled, we </span>
-00089 <span class="comment"> * will wake up before this time, otherwise the error APR_TIMEUP</span>
-00090 <span class="comment"> * is returned.</span>
-00091 <span class="comment"> */</span>
-00092 APR_DECLARE(<a class="code" href="group__apr__errno.html#ga0">apr_status_t</a>) apr_thread_cond_timedwait(apr_thread_cond_t *cond,
-00093 <a class="code" href="group__apr__thread__mutex.html#ga0">apr_thread_mutex_t</a> *mutex,
-00094 <a class="code" href="group__apr__time.html#ga3">apr_interval_time_t</a> timeout);
-00095 <span class="comment"></span>
-00096 <span class="comment">/**</span>
-00097 <span class="comment"> * Signals a single thread, if one exists, that is blocking on the given</span>
-00098 <span class="comment"> * condition variable. That thread is then scheduled to wake up and acquire</span>
-00099 <span class="comment"> * the associated mutex. Although it is not required, if predictable scheduling</span>
-00100 <span class="comment"> * is desired, that mutex must be locked while calling this function.</span>
-00101 <span class="comment"> * @param cond the condition variable on which to produce the signal.</span>
-00102 <span class="comment"> */</span>
-00103 APR_DECLARE(<a class="code" href="group__apr__errno.html#ga0">apr_status_t</a>) apr_thread_cond_signal(apr_thread_cond_t *cond);
-00104 <span class="comment"></span>
-00105 <span class="comment">/**</span>
-00106 <span class="comment"> * Signals all threads blocking on the given condition variable.</span>
-00107 <span class="comment"> * Each thread that was signaled is then scheduled to wake up and acquire</span>
-00108 <span class="comment"> * the associated mutex. This will happen in a serialized manner.</span>
-00109 <span class="comment"> * @param cond the condition variable on which to produce the broadcast.</span>
-00110 <span class="comment"> */</span>
-00111 APR_DECLARE(<a class="code" href="group__apr__errno.html#ga0">apr_status_t</a>) apr_thread_cond_broadcast(apr_thread_cond_t *cond);
-00112 <span class="comment"></span>
-00113 <span class="comment">/**</span>
-00114 <span class="comment"> * Destroy the condition variable and free the associated memory.</span>
-00115 <span class="comment"> * @param cond the condition variable to destroy.</span>
-00116 <span class="comment"> */</span>
-00117 APR_DECLARE(<a class="code" href="group__apr__errno.html#ga0">apr_status_t</a>) apr_thread_cond_destroy(apr_thread_cond_t *cond);
-00118 <span class="comment"></span>
-00119 <span class="comment">/**</span>
-00120 <span class="comment"> * Get the pool used by this thread_cond.</span>
-00121 <span class="comment"> * @return apr_pool_t the pool</span>
-00122 <span class="comment"> */</span>
-00123 APR_POOL_DECLARE_ACCESSOR(thread_cond);
-00124
-00125 #endif <span class="comment">/* APR_HAS_THREADS */</span>
-00126 <span class="comment"></span>
-00127 <span class="comment">/** @} */</span>
-00128
-00129 #ifdef __cplusplus
-00130 }
-00131 #endif
-00132
-00133 #endif <span class="comment">/* ! APR_THREAD_COND_H */</span>
-</div></pre><hr size="1"><address style="align: right;"><small>Generated on Wed Sep 1 21:36:05 2004 for Apache Portable Runtime by
+<h1>apr_thread_cond.h</h1><a href="apr__thread__cond_8h.html">Go to the documentation of this file.</a><pre class="fragment"><div>00001 <span class="comment">/* Copyright 2000-2005 The Apache Software Foundation or its licensors, as</span>
+00002 <span class="comment"> * applicable.</span>
+00003 <span class="comment"> *</span>
+00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span>
+00005 <span class="comment"> * you may not use this file except in compliance with the License.</span>
+00006 <span class="comment"> * You may obtain a copy of the License at</span>
+00007 <span class="comment"> *</span>
+00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
+00009 <span class="comment"> *</span>
+00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
+00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
+00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
+00014 <span class="comment"> * limitations under the License.</span>
+00015 <span class="comment"> */</span>
+00016
+00017 <span class="preprocessor">#ifndef APR_THREAD_COND_H</span>
+00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_THREAD_COND_H</span>
+00019 <span class="preprocessor"></span><span class="comment"></span>
+00020 <span class="comment">/**</span>
+00021 <span class="comment"> * @file apr_thread_cond.h</span>
+00022 <span class="comment"> * @brief APR Condition Variable Routines</span>
+00023 <span class="comment"> */</span>
+00024
+00025 <span class="preprocessor">#include "apr.h"</span>
+00026 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html">apr_pools.h</a>"</span>
+00027 <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html">apr_errno.h</a>"</span>
+00028 <span class="preprocessor">#include "<a class="code" href="apr__time_8h.html">apr_time.h</a>"</span>
+00029 <span class="preprocessor">#include "<a class="code" href="apr__thread__mutex_8h.html">apr_thread_mutex.h</a>"</span>
+00030
+00031 <span class="preprocessor">#ifdef __cplusplus</span>
+00032 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
+00033 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
+00034
+00035 <span class="preprocessor">#if APR_HAS_THREADS || defined(DOXYGEN)</span>
+00036 <span class="preprocessor"></span><span class="comment"></span>
+00037 <span class="comment">/**</span>
+00038 <span class="comment"> * @defgroup apr_thread_cond Condition Variable Routines</span>
+00039 <span class="comment"> * @ingroup APR </span>
+00040 <span class="comment"> * @{</span>
+00041 <span class="comment"> */</span>
+00042 <span class="comment"></span>
+00043 <span class="comment">/** Opaque structure for thread condition variables */</span>
+<a name="l00044"></a><a class="code" href="group__apr__thread__cond.html#ga0">00044</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__apr__thread__cond.html#ga0">apr_thread_cond_t</a> <a class="code" href="group__apr__thread__cond.html#ga0">apr_thread_cond_t</a>;
+00045 <span class="comment"></span>
+00046 <span class="comment">/**</span>
+00047 <span class="comment"> * Note: destroying a condition variable (or likewise, destroying or</span>
+00048 <span class="comment"> * clearing the pool from which a condition variable was allocated) if</span>
+00049 <span class="comment"> * any threads are blocked waiting on it gives undefined results.</span>
+00050 <span class="comment"> */</span>
+00051 <span class="comment"></span>
+00052 <span class="comment">/**</span>
+00053 <span class="comment"> * Create and initialize a condition variable that can be used to signal</span>
+00054 <span class="comment"> * and schedule threads in a single process.</span>
+00055 <span class="comment"> * @param cond the memory address where the newly created condition variable</span>
+00056 <span class="comment"> * will be stored.</span>
+00057 <span class="comment"> * @param pool the pool from which to allocate the mutex.</span>
+00058 <span class="comment"> */</span>
+00059 APR_DECLARE(apr_status_t) apr_thread_cond_create(apr_thread_cond_t **cond,
+00060 apr_pool_t *pool);
+00061 <span class="comment"></span>
+00062 <span class="comment">/**</span>
+00063 <span class="comment"> * Put the active calling thread to sleep until signaled to wake up. Each</span>
+00064 <span class="comment"> * condition variable must be associated with a mutex, and that mutex must</span>
+00065 <span class="comment"> * be locked before calling this function, or the behavior will be</span>
+00066 <span class="comment"> * undefined. As the calling thread is put to sleep, the given mutex</span>
+00067 <span class="comment"> * will be simultaneously released; and as this thread wakes up the lock</span>
+00068 <span class="comment"> * is again simultaneously acquired.</span>
+00069 <span class="comment"> * @param cond the condition variable on which to block.</span>
+00070 <span class="comment"> * @param mutex the mutex that must be locked upon entering this function,</span>
+00071 <span class="comment"> * is released while the thread is asleep, and is again acquired before</span>
+00072 <span class="comment"> * returning from this function.</span>
+00073 <span class="comment"> */</span>
+00074 APR_DECLARE(apr_status_t) apr_thread_cond_wait(apr_thread_cond_t *cond,
+00075 apr_thread_mutex_t *mutex);
+00076 <span class="comment"></span>
+00077 <span class="comment">/**</span>
+00078 <span class="comment"> * Put the active calling thread to sleep until signaled to wake up or</span>
+00079 <span class="comment"> * the timeout is reached. Each condition variable must be associated</span>
+00080 <span class="comment"> * with a mutex, and that mutex must be locked before calling this</span>
+00081 <span class="comment"> * function, or the behavior will be undefined. As the calling thread</span>
+00082 <span class="comment"> * is put to sleep, the given mutex will be simultaneously released;</span>
+00083 <span class="comment"> * and as this thread wakes up the lock is again simultaneously acquired.</span>
+00084 <span class="comment"> * @param cond the condition variable on which to block.</span>
+00085 <span class="comment"> * @param mutex the mutex that must be locked upon entering this function,</span>
+00086 <span class="comment"> * is released while the thread is asleep, and is again acquired before</span>
+00087 <span class="comment"> * returning from this function.</span>
+00088 <span class="comment"> * @param timeout The amount of time in microseconds to wait. This is </span>
+00089 <span class="comment"> * a maximum, not a minimum. If the condition is signaled, we </span>
+00090 <span class="comment"> * will wake up before this time, otherwise the error APR_TIMEUP</span>
+00091 <span class="comment"> * is returned.</span>
+00092 <span class="comment"> */</span>
+00093 APR_DECLARE(apr_status_t) apr_thread_cond_timedwait(apr_thread_cond_t *cond,
+00094 apr_thread_mutex_t *mutex,
+00095 apr_interval_time_t timeout);
+00096 <span class="comment"></span>
+00097 <span class="comment">/**</span>
+00098 <span class="comment"> * Signals a single thread, if one exists, that is blocking on the given</span>
+00099 <span class="comment"> * condition variable. That thread is then scheduled to wake up and acquire</span>
+00100 <span class="comment"> * the associated mutex. Although it is not required, if predictable scheduling</span>
+00101 <span class="comment"> * is desired, that mutex must be locked while calling this function.</span>
+00102 <span class="comment"> * @param cond the condition variable on which to produce the signal.</span>
+00103 <span class="comment"> */</span>
+00104 APR_DECLARE(apr_status_t) apr_thread_cond_signal(apr_thread_cond_t *cond);
+00105 <span class="comment"></span>
+00106 <span class="comment">/**</span>
+00107 <span class="comment"> * Signals all threads blocking on the given condition variable.</span>
+00108 <span class="comment"> * Each thread that was signaled is then scheduled to wake up and acquire</span>
+00109 <span class="comment"> * the associated mutex. This will happen in a serialized manner.</span>
+00110 <span class="comment"> * @param cond the condition variable on which to produce the broadcast.</span>
+00111 <span class="comment"> */</span>
+00112 APR_DECLARE(apr_status_t) apr_thread_cond_broadcast(apr_thread_cond_t *cond);
+00113 <span class="comment"></span>
+00114 <span class="comment">/**</span>
+00115 <span class="comment"> * Destroy the condition variable and free the associated memory.</span>
+00116 <span class="comment"> * @param cond the condition variable to destroy.</span>
+00117 <span class="comment"> */</span>
+00118 APR_DECLARE(apr_status_t) apr_thread_cond_destroy(apr_thread_cond_t *cond);
+00119 <span class="comment"></span>
+00120 <span class="comment">/**</span>
+00121 <span class="comment"> * Get the pool used by this thread_cond.</span>
+00122 <span class="comment"> * @return apr_pool_t the pool</span>
+00123 <span class="comment"> */</span>
+00124 APR_POOL_DECLARE_ACCESSOR(thread_cond);
+00125
+00126 #endif <span class="comment">/* APR_HAS_THREADS */</span>
+00127 <span class="comment"></span>
+00128 <span class="comment">/** @} */</span>
+00129
+00130 #ifdef __cplusplus
+00131 }
+00132 #endif
+00133
+00134 #endif <span class="comment">/* ! APR_THREAD_COND_H */</span>
+</div></pre><hr size="1"><address style="align: right;"><small>Generated on Mon Feb 7 13:18:25 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.8 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.7 </small></address>
</body>
</html>
Modified: apr/site/trunk/docs/docs/apr/apr__thread__cond_8h.html
URL: http://svn.apache.org/viewcvs/apr/site/trunk/docs/docs/apr/apr__thread__cond_8h.html?view=diff&r1=151767&r2=151768
==============================================================================
--- apr/site/trunk/docs/docs/apr/apr__thread__cond_8h.html (original)
+++ apr/site/trunk/docs/docs/apr/apr__thread__cond_8h.html Mon Feb 7 15:10:17 2005
@@ -3,9 +3,10 @@
<title>Apache Portable Runtime: apr_thread_cond.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
-<!-- Generated by Doxygen 1.3.8 -->
+<!-- Generated by Doxygen 1.3.7 -->
<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>apr_thread_cond.h File Reference</h1>APR Condition Variable Routines. <a href="#_details">More...</a>
+<h1>apr_thread_cond.h File Reference</h1>APR Condition Variable Routines.
+<a href="#_details">More...</a>
<p>
<code>#include "apr.h"</code><br>
<code>#include "<a class="el" href="apr__pools_8h-source.html">apr_pools.h</a>"</code><br>
@@ -38,8 +39,8 @@
<hr><a name="_details"></a><h2>Detailed Description</h2>
APR Condition Variable Routines.
<p>
-<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 1 21:36:05 2004 for Apache Portable Runtime by
+<hr size="1"><address style="align: right;"><small>Generated on Mon Feb 7 13:18:25 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.8 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.7 </small></address>
</body>
</html>
Modified: apr/site/trunk/docs/docs/apr/apr__thread__mutex_8h-source.html
URL: http://svn.apache.org/viewcvs/apr/site/trunk/docs/docs/apr/apr__thread__mutex_8h-source.html?view=diff&r1=151767&r2=151768
==============================================================================
--- apr/site/trunk/docs/docs/apr/apr__thread__mutex_8h-source.html (original)
+++ apr/site/trunk/docs/docs/apr/apr__thread__mutex_8h-source.html Mon Feb 7 15:10:17 2005
@@ -3,119 +3,120 @@
<title>Apache Portable Runtime: apr_thread_mutex.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
-<!-- Generated by Doxygen 1.3.8 -->
+<!-- Generated by Doxygen 1.3.7 -->
<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>apr_thread_mutex.h</h1><a href="apr__thread__mutex_8h.html">Go to the documentation of this file.</a><pre class="fragment"><div>00001 <span class="comment">/* Copyright 2000-2004 The Apache Software Foundation</span>
-00002 <span class="comment"> *</span>
-00003 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span>
-00004 <span class="comment"> * you may not use this file except in compliance with the License.</span>
-00005 <span class="comment"> * You may obtain a copy of the License at</span>
-00006 <span class="comment"> *</span>
-00007 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
-00008 <span class="comment"> *</span>
-00009 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
-00010 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
-00011 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
-00012 <span class="comment"> * See the License for the specific language governing permissions and</span>
-00013 <span class="comment"> * limitations under the License.</span>
-00014 <span class="comment"> */</span>
-00015
-00016 <span class="preprocessor">#ifndef APR_THREAD_MUTEX_H</span>
-00017 <span class="preprocessor"></span><span class="preprocessor">#define APR_THREAD_MUTEX_H</span>
-00018 <span class="preprocessor"></span><span class="comment"></span>
-00019 <span class="comment">/**</span>
-00020 <span class="comment"> * @file apr_thread_mutex.h</span>
-00021 <span class="comment"> * @brief APR Thread Mutex Routines</span>
-00022 <span class="comment"> */</span>
-00023
-00024 <span class="preprocessor">#include "apr.h"</span>
-00025 <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html">apr_errno.h</a>"</span>
-00026
-00027 <span class="preprocessor">#ifdef __cplusplus</span>
-00028 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
-00029 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
-00030
-00031 <span class="preprocessor">#if APR_HAS_THREADS || defined(DOXYGEN)</span>
-00032 <span class="preprocessor"></span><span class="comment"></span>
-00033 <span class="comment">/**</span>
-00034 <span class="comment"> * @defgroup apr_thread_mutex Thread Mutex Routines</span>
-00035 <span class="comment"> * @ingroup APR </span>
-00036 <span class="comment"> * @{</span>
-00037 <span class="comment"> */</span>
-00038 <span class="comment"></span>
-00039 <span class="comment">/** Opaque thread-local mutex structure */</span>
-<a name="l00040"></a><a class="code" href="group__apr__thread__mutex.html#ga0">00040</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__apr__thread__mutex.html#ga0">apr_thread_mutex_t</a> <a class="code" href="group__apr__thread__mutex.html#ga0">apr_thread_mutex_t</a>;
-00041
-<a name="l00042"></a><a class="code" href="group__apr__thread__mutex.html#ga7">00042</a> <span class="preprocessor">#define APR_THREAD_MUTEX_DEFAULT 0x0 </span><span class="comment">/**< platform-optimal lock behavior */</span>
-<a name="l00043"></a><a class="code" href="group__apr__thread__mutex.html#ga8">00043</a> <span class="preprocessor">#define APR_THREAD_MUTEX_NESTED 0x1 </span><span class="comment">/**< enable nested (recursive) locks */</span>
-<a name="l00044"></a><a class="code" href="group__apr__thread__mutex.html#ga9">00044</a> <span class="preprocessor">#define APR_THREAD_MUTEX_UNNESTED 0x2 </span><span class="comment">/**< disable nested locks */</span>
-00045
-00046 <span class="comment">/* Delayed the include to avoid a circular reference */</span>
-00047 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html">apr_pools.h</a>"</span>
-00048 <span class="comment"></span>
-00049 <span class="comment">/**</span>
-00050 <span class="comment"> * Create and initialize a mutex that can be used to synchronize threads.</span>
-00051 <span class="comment"> * @param mutex the memory address where the newly created mutex will be</span>
-00052 <span class="comment"> * stored.</span>
-00053 <span class="comment"> * @param flags Or'ed value of:</span>
-00054 <span class="comment"> * <PRE></span>
-00055 <span class="comment"> * APR_THREAD_MUTEX_DEFAULT platform-optimal lock behavior.</span>
-00056 <span class="comment"> * APR_THREAD_MUTEX_NESTED enable nested (recursive) locks.</span>
-00057 <span class="comment"> * APR_THREAD_MUTEX_UNNESTED disable nested locks (non-recursive).</span>
-00058 <span class="comment"> * </PRE></span>
-00059 <span class="comment"> * @param pool the pool from which to allocate the mutex.</span>
-00060 <span class="comment"> * @warning Be cautious in using APR_THREAD_MUTEX_DEFAULT. While this is the</span>
-00061 <span class="comment"> * most optimial mutex based on a given platform's performance charateristics,</span>
-00062 <span class="comment"> * it will behave as either a nested or an unnested lock.</span>
-00063 <span class="comment"> */</span>
-00064 APR_DECLARE(<a class="code" href="group__apr__errno.html#ga0">apr_status_t</a>) apr_thread_mutex_create(apr_thread_mutex_t **mutex,
-00065 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags,
-00066 <a class="code" href="group__apr__pools.html#ga0">apr_pool_t</a> *pool);<span class="comment"></span>
-00067 <span class="comment">/**</span>
-00068 <span class="comment"> * Acquire the lock for the given mutex. If the mutex is already locked,</span>
-00069 <span class="comment"> * the current thread will be put to sleep until the lock becomes available.</span>
-00070 <span class="comment"> * @param mutex the mutex on which to acquire the lock.</span>
-00071 <span class="comment"> */</span>
-00072 APR_DECLARE(<a class="code" href="group__apr__errno.html#ga0">apr_status_t</a>) apr_thread_mutex_lock(apr_thread_mutex_t *mutex);
-00073 <span class="comment"></span>
-00074 <span class="comment">/**</span>
-00075 <span class="comment"> * Attempt to acquire the lock for the given mutex. If the mutex has already</span>
-00076 <span class="comment"> * been acquired, the call returns immediately with APR_EBUSY. Note: it</span>
-00077 <span class="comment"> * is important that the APR_STATUS_IS_EBUSY(s) macro be used to determine</span>
-00078 <span class="comment"> * if the return value was APR_EBUSY, for portability reasons.</span>
-00079 <span class="comment"> * @param mutex the mutex on which to attempt the lock acquiring.</span>
-00080 <span class="comment"> */</span>
-00081 APR_DECLARE(<a class="code" href="group__apr__errno.html#ga0">apr_status_t</a>) apr_thread_mutex_trylock(apr_thread_mutex_t *mutex);
-00082 <span class="comment"></span>
-00083 <span class="comment">/**</span>
-00084 <span class="comment"> * Release the lock for the given mutex.</span>
-00085 <span class="comment"> * @param mutex the mutex from which to release the lock.</span>
-00086 <span class="comment"> */</span>
-00087 APR_DECLARE(<a class="code" href="group__apr__errno.html#ga0">apr_status_t</a>) apr_thread_mutex_unlock(apr_thread_mutex_t *mutex);
-00088 <span class="comment"></span>
-00089 <span class="comment">/**</span>
-00090 <span class="comment"> * Destroy the mutex and free the memory associated with the lock.</span>
-00091 <span class="comment"> * @param mutex the mutex to destroy.</span>
-00092 <span class="comment"> */</span>
-00093 APR_DECLARE(<a class="code" href="group__apr__errno.html#ga0">apr_status_t</a>) apr_thread_mutex_destroy(apr_thread_mutex_t *mutex);
-00094 <span class="comment"></span>
-00095 <span class="comment">/**</span>
-00096 <span class="comment"> * Get the pool used by this thread_mutex.</span>
-00097 <span class="comment"> * @return apr_pool_t the pool</span>
-00098 <span class="comment"> */</span>
-00099 APR_POOL_DECLARE_ACCESSOR(thread_mutex);
-00100
-00101 #endif <span class="comment">/* APR_HAS_THREADS */</span>
-00102 <span class="comment"></span>
-00103 <span class="comment">/** @} */</span>
-00104
-00105 #ifdef __cplusplus
-00106 }
-00107 #endif
-00108
-00109 #endif <span class="comment">/* ! APR_THREAD_MUTEX_H */</span>
-</div></pre><hr size="1"><address style="align: right;"><small>Generated on Wed Sep 1 21:36:05 2004 for Apache Portable Runtime by
+<h1>apr_thread_mutex.h</h1><a href="apr__thread__mutex_8h.html">Go to the documentation of this file.</a><pre class="fragment"><div>00001 <span class="comment">/* Copyright 2000-2005 The Apache Software Foundation or its licensors, as</span>
+00002 <span class="comment"> * applicable.</span>
+00003 <span class="comment"> *</span>
+00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span>
+00005 <span class="comment"> * you may not use this file except in compliance with the License.</span>
+00006 <span class="comment"> * You may obtain a copy of the License at</span>
+00007 <span class="comment"> *</span>
+00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
+00009 <span class="comment"> *</span>
+00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
+00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
+00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
+00014 <span class="comment"> * limitations under the License.</span>
+00015 <span class="comment"> */</span>
+00016
+00017 <span class="preprocessor">#ifndef APR_THREAD_MUTEX_H</span>
+00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_THREAD_MUTEX_H</span>
+00019 <span class="preprocessor"></span><span class="comment"></span>
+00020 <span class="comment">/**</span>
+00021 <span class="comment"> * @file apr_thread_mutex.h</span>
+00022 <span class="comment"> * @brief APR Thread Mutex Routines</span>
+00023 <span class="comment"> */</span>
+00024
+00025 <span class="preprocessor">#include "apr.h"</span>
+00026 <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html">apr_errno.h</a>"</span>
+00027
+00028 <span class="preprocessor">#ifdef __cplusplus</span>
+00029 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
+00030 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
+00031
+00032 <span class="preprocessor">#if APR_HAS_THREADS || defined(DOXYGEN)</span>
+00033 <span class="preprocessor"></span><span class="comment"></span>
+00034 <span class="comment">/**</span>
+00035 <span class="comment"> * @defgroup apr_thread_mutex Thread Mutex Routines</span>
+00036 <span class="comment"> * @ingroup APR </span>
+00037 <span class="comment"> * @{</span>
+00038 <span class="comment"> */</span>
+00039 <span class="comment"></span>
+00040 <span class="comment">/** Opaque thread-local mutex structure */</span>
+<a name="l00041"></a><a class="code" href="group__apr__thread__mutex.html#ga0">00041</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__apr__thread__mutex.html#ga0">apr_thread_mutex_t</a> <a class="code" href="group__apr__thread__mutex.html#ga0">apr_thread_mutex_t</a>;
+00042
+<a name="l00043"></a><a class="code" href="group__apr__thread__mutex.html#ga7">00043</a> <span class="preprocessor">#define APR_THREAD_MUTEX_DEFAULT 0x0 </span><span class="comment">/**< platform-optimal lock behavior */</span>
+<a name="l00044"></a><a class="code" href="group__apr__thread__mutex.html#ga8">00044</a> <span class="preprocessor">#define APR_THREAD_MUTEX_NESTED 0x1 </span><span class="comment">/**< enable nested (recursive) locks */</span>
+<a name="l00045"></a><a class="code" href="group__apr__thread__mutex.html#ga9">00045</a> <span class="preprocessor">#define APR_THREAD_MUTEX_UNNESTED 0x2 </span><span class="comment">/**< disable nested locks */</span>
+00046
+00047 <span class="comment">/* Delayed the include to avoid a circular reference */</span>
+00048 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html">apr_pools.h</a>"</span>
+00049 <span class="comment"></span>
+00050 <span class="comment">/**</span>
+00051 <span class="comment"> * Create and initialize a mutex that can be used to synchronize threads.</span>
+00052 <span class="comment"> * @param mutex the memory address where the newly created mutex will be</span>
+00053 <span class="comment"> * stored.</span>
+00054 <span class="comment"> * @param flags Or'ed value of:</span>
+00055 <span class="comment"> * <PRE></span>
+00056 <span class="comment"> * APR_THREAD_MUTEX_DEFAULT platform-optimal lock behavior.</span>
+00057 <span class="comment"> * APR_THREAD_MUTEX_NESTED enable nested (recursive) locks.</span>
+00058 <span class="comment"> * APR_THREAD_MUTEX_UNNESTED disable nested locks (non-recursive).</span>
+00059 <span class="comment"> * </PRE></span>
+00060 <span class="comment"> * @param pool the pool from which to allocate the mutex.</span>
+00061 <span class="comment"> * @warning Be cautious in using APR_THREAD_MUTEX_DEFAULT. While this is the</span>
+00062 <span class="comment"> * most optimial mutex based on a given platform's performance charateristics,</span>
+00063 <span class="comment"> * it will behave as either a nested or an unnested lock.</span>
+00064 <span class="comment"> */</span>
+00065 APR_DECLARE(apr_status_t) apr_thread_mutex_create(apr_thread_mutex_t **mutex,
+00066 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags,
+00067 apr_pool_t *pool);<span class="comment"></span>
+00068 <span class="comment">/**</span>
+00069 <span class="comment"> * Acquire the lock for the given mutex. If the mutex is already locked,</span>
+00070 <span class="comment"> * the current thread will be put to sleep until the lock becomes available.</span>
+00071 <span class="comment"> * @param mutex the mutex on which to acquire the lock.</span>
+00072 <span class="comment"> */</span>
+00073 APR_DECLARE(apr_status_t) apr_thread_mutex_lock(apr_thread_mutex_t *mutex);
+00074 <span class="comment"></span>
+00075 <span class="comment">/**</span>
+00076 <span class="comment"> * Attempt to acquire the lock for the given mutex. If the mutex has already</span>
+00077 <span class="comment"> * been acquired, the call returns immediately with APR_EBUSY. Note: it</span>
+00078 <span class="comment"> * is important that the APR_STATUS_IS_EBUSY(s) macro be used to determine</span>
+00079 <span class="comment"> * if the return value was APR_EBUSY, for portability reasons.</span>
+00080 <span class="comment"> * @param mutex the mutex on which to attempt the lock acquiring.</span>
+00081 <span class="comment"> */</span>
+00082 APR_DECLARE(apr_status_t) apr_thread_mutex_trylock(apr_thread_mutex_t *mutex);
+00083 <span class="comment"></span>
+00084 <span class="comment">/**</span>
+00085 <span class="comment"> * Release the lock for the given mutex.</span>
+00086 <span class="comment"> * @param mutex the mutex from which to release the lock.</span>
+00087 <span class="comment"> */</span>
+00088 APR_DECLARE(apr_status_t) apr_thread_mutex_unlock(apr_thread_mutex_t *mutex);
+00089 <span class="comment"></span>
+00090 <span class="comment">/**</span>
+00091 <span class="comment"> * Destroy the mutex and free the memory associated with the lock.</span>
+00092 <span class="comment"> * @param mutex the mutex to destroy.</span>
+00093 <span class="comment"> */</span>
+00094 APR_DECLARE(apr_status_t) apr_thread_mutex_destroy(apr_thread_mutex_t *mutex);
+00095 <span class="comment"></span>
+00096 <span class="comment">/**</span>
+00097 <span class="comment"> * Get the pool used by this thread_mutex.</span>
+00098 <span class="comment"> * @return apr_pool_t the pool</span>
+00099 <span class="comment"> */</span>
+00100 APR_POOL_DECLARE_ACCESSOR(thread_mutex);
+00101
+00102 #endif <span class="comment">/* APR_HAS_THREADS */</span>
+00103 <span class="comment"></span>
+00104 <span class="comment">/** @} */</span>
+00105
+00106 #ifdef __cplusplus
+00107 }
+00108 #endif
+00109
+00110 #endif <span class="comment">/* ! APR_THREAD_MUTEX_H */</span>
+</div></pre><hr size="1"><address style="align: right;"><small>Generated on Mon Feb 7 13:18:25 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.8 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.7 </small></address>
</body>
</html>
Modified: apr/site/trunk/docs/docs/apr/apr__thread__mutex_8h.html
URL: http://svn.apache.org/viewcvs/apr/site/trunk/docs/docs/apr/apr__thread__mutex_8h.html?view=diff&r1=151767&r2=151768
==============================================================================
--- apr/site/trunk/docs/docs/apr/apr__thread__mutex_8h.html (original)
+++ apr/site/trunk/docs/docs/apr/apr__thread__mutex_8h.html Mon Feb 7 15:10:17 2005
@@ -3,9 +3,10 @@
<title>Apache Portable Runtime: apr_thread_mutex.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
-<!-- Generated by Doxygen 1.3.8 -->
+<!-- Generated by Doxygen 1.3.7 -->
<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>apr_thread_mutex.h File Reference</h1>APR Thread Mutex Routines. <a href="#_details">More...</a>
+<h1>apr_thread_mutex.h File Reference</h1>APR Thread Mutex Routines.
+<a href="#_details">More...</a>
<p>
<code>#include "apr.h"</code><br>
<code>#include "<a class="el" href="apr__errno_8h-source.html">apr_errno.h</a>"</code><br>
@@ -15,11 +16,11 @@
<a href="apr__thread__mutex_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></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__thread__mutex.html#ga7">APR_THREAD_MUTEX_DEFAULT</a> 0x0</td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__apr__thread__mutex.html#ga7">APR_THREAD_MUTEX_DEFAULT</a> 0x0 /**< platform-optimal lock behavior */</td></tr>
-<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__apr__thread__mutex.html#ga8">APR_THREAD_MUTEX_NESTED</a> 0x1</td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__apr__thread__mutex.html#ga8">APR_THREAD_MUTEX_NESTED</a> 0x1 /**< enable nested (recursive) locks */</td></tr>
-<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__apr__thread__mutex.html#ga9">APR_THREAD_MUTEX_UNNESTED</a> 0x2</td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>#define </td><td class="memItemRight" valign=bottom><a class="el" href="group__apr__thread__mutex.html#ga9">APR_THREAD_MUTEX_UNNESTED</a> 0x2 /**< disable nested locks */</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__thread__mutex.html#ga0">apr_thread_mutex_t</a> </td><td class="memItemRight" valign=bottom><a class="el" href="group__apr__thread__mutex.html#ga0">apr_thread_mutex_t</a></td></tr>
@@ -41,8 +42,8 @@
<hr><a name="_details"></a><h2>Detailed Description</h2>
APR Thread Mutex Routines.
<p>
-<hr size="1"><address style="align: right;"><small>Generated on Wed Sep 1 21:36:05 2004 for Apache Portable Runtime by
+<hr size="1"><address style="align: right;"><small>Generated on Mon Feb 7 13:18:25 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.8 </small></address>
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.7 </small></address>
</body>
</html>