<!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_mutex.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_mutex.h</h1><a href="apr__thread__mutex_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_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 "<a class="code" href="apr_8h.html">apr.h</a>"</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 <a class="code" href="group__apr__platform.html#ga123">APR_DECLARE</a>(apr_status_t) apr_thread_mutex_create(apr_thread_mutex_t **mutex, 00065 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags, 00066 apr_pool_t *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(apr_status_t) 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(apr_status_t) 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(apr_status_t) 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(apr_status_t) 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> </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>