<!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">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></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"><a name="l00001"></a>00001 <span class="comment">/* Copyright 2000-2005 The Apache Software Foundation or its licensors, as</span>
<a name="l00002"></a>00002 <span class="comment"> * applicable.</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span>
<a name="l00005"></a>00005 <span class="comment"> * you may not use this file except in compliance with the License.</span>
<a name="l00006"></a>00006 <span class="comment"> * You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment"> *</span>
<a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"> */</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef APR_THREAD_MUTEX_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_THREAD_MUTEX_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">/**</span>
<a name="l00021"></a>00021 <span class="comment"> * @file apr_thread_mutex.h</span>
<a name="l00022"></a>00022 <span class="comment"> * @brief APR Thread Mutex Routines</span>
<a name="l00023"></a>00023 <span class="comment"> */</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="apr_8h.html">apr.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="apr__errno_8h.html">apr_errno.h</a>"</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00030"></a>00030 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="preprocessor">#if APR_HAS_THREADS || defined(DOXYGEN)</span>
<a name="l00033"></a>00033 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">/**</span>
<a name="l00035"></a>00035 <span class="comment"> * @defgroup apr_thread_mutex Thread Mutex Routines</span>
<a name="l00036"></a>00036 <span class="comment"> * @ingroup APR </span>
<a name="l00037"></a>00037 <span class="comment"> * @{</span>
<a name="l00038"></a>00038 <span class="comment"> */</span>
<a name="l00039"></a>00039 <span class="comment"></span>
<a name="l00040"></a>00040 <span class="comment">/** Opaque thread-local mutex structure */</span>
<a name="l00041"></a><a class="code" href="group__apr__thread__mutex.html#g403b0b4658868d93e2b773e671ef06a7">00041</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__apr__thread__mutex.html#g403b0b4658868d93e2b773e671ef06a7">apr_thread_mutex_t</a> apr_thread_mutex_t;
<a name="l00042"></a>00042
<a name="l00043"></a><a class="code" href="group__apr__thread__mutex.html#gb15e4da7c04dcc4b3b5f1ca57c416129">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#g78d5e51a85c71f7bc2da2a293d7cc2c1">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#gebc1e764641c2b9f5a890f5a99f0f064">00045</a> <span class="preprocessor">#define APR_THREAD_MUTEX_UNNESTED 0x2 </span><span class="comment">/**< disable nested locks */</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="comment">/* Delayed the include to avoid a circular reference */</span>
<a name="l00048"></a>00048 <span class="preprocessor">#include "<a class="code" href="apr__pools_8h.html">apr_pools.h</a>"</span>
<a name="l00049"></a>00049 <span class="comment"></span>
<a name="l00050"></a>00050 <span class="comment">/**</span>
<a name="l00051"></a>00051 <span class="comment"> * Create and initialize a mutex that can be used to synchronize threads.</span>
<a name="l00052"></a>00052 <span class="comment"> * @param mutex the memory address where the newly created mutex will be</span>
<a name="l00053"></a>00053 <span class="comment"> * stored.</span>
<a name="l00054"></a>00054 <span class="comment"> * @param flags Or'ed value of:</span>
<a name="l00055"></a>00055 <span class="comment"> * <PRE></span>
<a name="l00056"></a>00056 <span class="comment"> * APR_THREAD_MUTEX_DEFAULT platform-optimal lock behavior.</span>
<a name="l00057"></a>00057 <span class="comment"> * APR_THREAD_MUTEX_NESTED enable nested (recursive) locks.</span>
<a name="l00058"></a>00058 <span class="comment"> * APR_THREAD_MUTEX_UNNESTED disable nested locks (non-recursive).</span>
<a name="l00059"></a>00059 <span class="comment"> * </PRE></span>
<a name="l00060"></a>00060 <span class="comment"> * @param pool the pool from which to allocate the mutex.</span>
<a name="l00061"></a>00061 <span class="comment"> * @warning Be cautious in using APR_THREAD_MUTEX_DEFAULT. While this is the</span>
<a name="l00062"></a>00062 <span class="comment"> * most optimial mutex based on a given platform's performance charateristics,</span>
<a name="l00063"></a>00063 <span class="comment"> * it will behave as either a nested or an unnested lock.</span>
<a name="l00064"></a>00064 <span class="comment"> */</span>
<a name="l00065"></a>00065 <a class="code" href="group__apr__platform.html#g4a5cbc739c4e19ab450020163d0899d4">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>) <a class="code" href="group__apr__thread__mutex.html#g81a32c9fad11d67df29edccd166875ec">apr_thread_mutex_create</a>(apr_thread_mutex_t **mutex,
<a name="l00066"></a>00066 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags,
<a name="l00067"></a>00067 <a class="code" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *pool);<span class="comment"></span>
<a name="l00068"></a>00068 <span class="comment">/**</span>
<a name="l00069"></a>00069 <span class="comment"> * Acquire the lock for the given mutex. If the mutex is already locked,</span>
<a name="l00070"></a>00070 <span class="comment"> * the current thread will be put to sleep until the lock becomes available.</span>
<a name="l00071"></a>00071 <span class="comment"> * @param mutex the mutex on which to acquire the lock.</span>
<a name="l00072"></a>00072 <span class="comment"> */</span>
<a name="l00073"></a>00073 <a class="code" href="group__apr__platform.html#g4a5cbc739c4e19ab450020163d0899d4">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>) <a class="code" href="group__apr__thread__mutex.html#g47644b0e0bb9b9c02498fe3a128f9724">apr_thread_mutex_lock</a>(apr_thread_mutex_t *mutex);
<a name="l00074"></a>00074 <span class="comment"></span>
<a name="l00075"></a>00075 <span class="comment">/**</span>
<a name="l00076"></a>00076 <span class="comment"> * Attempt to acquire the lock for the given mutex. If the mutex has already</span>
<a name="l00077"></a>00077 <span class="comment"> * been acquired, the call returns immediately with APR_EBUSY. Note: it</span>
<a name="l00078"></a>00078 <span class="comment"> * is important that the APR_STATUS_IS_EBUSY(s) macro be used to determine</span>
<a name="l00079"></a>00079 <span class="comment"> * if the return value was APR_EBUSY, for portability reasons.</span>
<a name="l00080"></a>00080 <span class="comment"> * @param mutex the mutex on which to attempt the lock acquiring.</span>
<a name="l00081"></a>00081 <span class="comment"> */</span>
<a name="l00082"></a>00082 <a class="code" href="group__apr__platform.html#g4a5cbc739c4e19ab450020163d0899d4">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>) <a class="code" href="group__apr__thread__mutex.html#g53fd99e7042b7db29538af5f39bd71a7">apr_thread_mutex_trylock</a>(apr_thread_mutex_t *mutex);
<a name="l00083"></a>00083 <span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment">/**</span>
<a name="l00085"></a>00085 <span class="comment"> * Release the lock for the given mutex.</span>
<a name="l00086"></a>00086 <span class="comment"> * @param mutex the mutex from which to release the lock.</span>
<a name="l00087"></a>00087 <span class="comment"> */</span>
<a name="l00088"></a>00088 <a class="code" href="group__apr__platform.html#g4a5cbc739c4e19ab450020163d0899d4">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>) <a class="code" href="group__apr__thread__mutex.html#g40cd77cd9eda0e8b3c9752eae6b4cf65">apr_thread_mutex_unlock</a>(apr_thread_mutex_t *mutex);
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment">/**</span>
<a name="l00091"></a>00091 <span class="comment"> * Destroy the mutex and free the memory associated with the lock.</span>
<a name="l00092"></a>00092 <span class="comment"> * @param mutex the mutex to destroy.</span>
<a name="l00093"></a>00093 <span class="comment"> */</span>
<a name="l00094"></a>00094 <a class="code" href="group__apr__platform.html#g4a5cbc739c4e19ab450020163d0899d4">APR_DECLARE</a>(<a class="code" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a>) <a class="code" href="group__apr__thread__mutex.html#g305ffad2bbcdf015a4b483d5a1352e75">apr_thread_mutex_destroy</a>(apr_thread_mutex_t *mutex);
<a name="l00095"></a>00095 <span class="comment"></span>
<a name="l00096"></a>00096 <span class="comment">/**</span>
<a name="l00097"></a>00097 <span class="comment"> * Get the pool used by this thread_mutex.</span>
<a name="l00098"></a>00098 <span class="comment"> * @return apr_pool_t the pool</span>
<a name="l00099"></a>00099 <span class="comment"> */</span>
<a name="l00100"></a>00100 <a class="code" href="group__apr__pools.html#g6dda96940d296b27a1bc98d9f49735e4">APR_POOL_DECLARE_ACCESSOR</a>(thread_mutex);
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="preprocessor">#endif </span><span class="comment">/* APR_HAS_THREADS */</span>
<a name="l00103"></a>00103 <span class="comment"></span>
<a name="l00104"></a>00104 <span class="comment">/** @} */</span>
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00107"></a>00107 <span class="preprocessor"></span>}
<a name="l00108"></a>00108 <span class="preprocessor">#endif</span>
<a name="l00109"></a>00109 <span class="preprocessor"></span>
<a name="l00110"></a>00110 <span class="preprocessor">#endif </span><span class="comment">/* ! APR_THREAD_MUTEX_H */</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Tue May 31 12:20:26 2011 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.4.7 </small></address>
</body>
</html>
