<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <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.9.1 --> <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> <div class="nav"> <a class="el" href="dir_000000.html">home</a> / <a class="el" href="dir_000001.html">oden</a> / <a class="el" href="dir_000002.html">RPM</a> / <a class="el" href="dir_000003.html">BUILD</a> / <a class="el" href="dir_000004.html">apr-1.1.1</a> / <a class="el" href="dir_000005.html">include</a></div> <h1>apr_thread_cond.h</h1><a href="apr__thread__cond_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">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 "<a class="code" href="apr_8h.html">apr.h</a>"</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 <a class="code" href="group__apr__platform.html#ga123">APR_DECLARE</a>(apr_status_t) apr_thread_cond_create(apr_thread_cond_t **cond, 00059 apr_pool_t *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(apr_status_t) apr_thread_cond_wait(apr_thread_cond_t *cond, 00074 apr_thread_mutex_t *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(apr_status_t) apr_thread_cond_timedwait(apr_thread_cond_t *cond, 00093 apr_thread_mutex_t *mutex, 00094 apr_interval_time_t 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(apr_status_t) 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(apr_status_t) 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(apr_status_t) 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> </pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Mar 20 19:52:26 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.9.1 </small></address> </body> </html>