📄 apr__proc__mutex_8h-source.html
字号:
<!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_proc_mutex.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- 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_proc_mutex.h</h1><a href="apr__proc__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_PROC_MUTEX_H</span>
00018 <span class="preprocessor"></span><span class="preprocessor">#define APR_PROC_MUTEX_H</span>
00019 <span class="preprocessor"></span><span class="comment"></span>
00020 <span class="comment">/**</span>
00021 <span class="comment"> * @file apr_proc_mutex.h</span>
00022 <span class="comment"> * @brief APR Process Locking 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
00029 <span class="preprocessor">#ifdef __cplusplus</span>
00030 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
00031 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
00032 <span class="comment"></span>
00033 <span class="comment">/**</span>
00034 <span class="comment"> * @defgroup apr_proc_mutex Process Locking 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">/** </span>
00040 <span class="comment"> * Enumerated potential types for APR process locking methods</span>
00041 <span class="comment"> * @warning Check APR_HAS_foo_SERIALIZE defines to see if the platform supports</span>
00042 <span class="comment"> * APR_LOCK_foo. Only APR_LOCK_DEFAULT is portable.</span>
00043 <span class="comment"> */</span>
<a name="l00044"></a><a class="code" href="group__apr__proc__mutex.html#ga12">00044</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
00045 <a class="code" href="group__apr__proc__mutex.html#gga12a1">APR_LOCK_FCNTL</a>, <span class="comment">/**< fcntl() */</span>
00046 <a class="code" href="group__apr__proc__mutex.html#gga12a2">APR_LOCK_FLOCK</a>, <span class="comment">/**< flock() */</span>
00047 <a class="code" href="group__apr__proc__mutex.html#gga12a3">APR_LOCK_SYSVSEM</a>, <span class="comment">/**< System V Semaphores */</span>
00048 <a class="code" href="group__apr__proc__mutex.html#gga12a4">APR_LOCK_PROC_PTHREAD</a>, <span class="comment">/**< POSIX pthread process-based locking */</span>
00049 <a class="code" href="group__apr__proc__mutex.html#gga12a5">APR_LOCK_POSIXSEM</a>, <span class="comment">/**< POSIX semaphore process-based locking */</span>
00050 <a class="code" href="group__apr__proc__mutex.html#gga12a6">APR_LOCK_DEFAULT</a> <span class="comment">/**< Use the default process lock */</span>
00051 } <a class="code" href="group__apr__proc__mutex.html#ga12">apr_lockmech_e</a>;
00052 <span class="comment"></span>
00053 <span class="comment">/** Opaque structure representing a process mutex. */</span>
<a name="l00054"></a><a class="code" href="group__apr__proc__mutex.html#ga0">00054</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__apr__proc__mutex.html#ga0">apr_proc_mutex_t</a> <a class="code" href="group__apr__proc__mutex.html#ga0">apr_proc_mutex_t</a>;
00055
00056 <span class="comment">/* Function definitions */</span>
00057 <span class="comment"></span>
00058 <span class="comment">/**</span>
00059 <span class="comment"> * Create and initialize a mutex that can be used to synchronize processes.</span>
00060 <span class="comment"> * @param mutex the memory address where the newly created mutex will be</span>
00061 <span class="comment"> * stored.</span>
00062 <span class="comment"> * @param fname A file name to use if the lock mechanism requires one. This</span>
00063 <span class="comment"> * argument should always be provided. The lock code itself will</span>
00064 <span class="comment"> * determine if it should be used.</span>
00065 <span class="comment"> * @param mech The mechanism to use for the interprocess lock, if any; one of</span>
00066 <span class="comment"> * <PRE></span>
00067 <span class="comment"> * APR_LOCK_FCNTL</span>
00068 <span class="comment"> * APR_LOCK_FLOCK</span>
00069 <span class="comment"> * APR_LOCK_SYSVSEM</span>
00070 <span class="comment"> * APR_LOCK_POSIXSEM</span>
00071 <span class="comment"> * APR_LOCK_PROC_PTHREAD</span>
00072 <span class="comment"> * APR_LOCK_DEFAULT pick the default mechanism for the platform</span>
00073 <span class="comment"> * </PRE></span>
00074 <span class="comment"> * @param pool the pool from which to allocate the mutex.</span>
00075 <span class="comment"> * @see apr_lockmech_e</span>
00076 <span class="comment"> * @warning Check APR_HAS_foo_SERIALIZE defines to see if the platform supports</span>
00077 <span class="comment"> * APR_LOCK_foo. Only APR_LOCK_DEFAULT is portable.</span>
00078 <span class="comment"> */</span>
00079 APR_DECLARE(apr_status_t) apr_proc_mutex_create(apr_proc_mutex_t **mutex,
00080 const <span class="keywordtype">char</span> *fname,
00081 apr_lockmech_e mech,
00082 apr_pool_t *pool);
00083 <span class="comment"></span>
00084 <span class="comment">/**</span>
00085 <span class="comment"> * Re-open a mutex in a child process.</span>
00086 <span class="comment"> * @param mutex The newly re-opened mutex structure.</span>
00087 <span class="comment"> * @param fname A file name to use if the mutex mechanism requires one. This</span>
00088 <span class="comment"> * argument should always be provided. The mutex code itself will</span>
00089 <span class="comment"> * determine if it should be used. This filename should be the </span>
00090 <span class="comment"> * same one that was passed to apr_proc_mutex_create().</span>
00091 <span class="comment"> * @param pool The pool to operate on.</span>
00092 <span class="comment"> * @remark This function must be called to maintain portability, even</span>
00093 <span class="comment"> * if the underlying lock mechanism does not require it.</span>
00094 <span class="comment"> */</span>
00095 APR_DECLARE(apr_status_t) apr_proc_mutex_child_init(apr_proc_mutex_t **mutex,
00096 const <span class="keywordtype">char</span> *fname,
00097 apr_pool_t *pool);
00098 <span class="comment"></span>
00099 <span class="comment">/**</span>
00100 <span class="comment"> * Acquire the lock for the given mutex. If the mutex is already locked,</span>
00101 <span class="comment"> * the current thread will be put to sleep until the lock becomes available.</span>
00102 <span class="comment"> * @param mutex the mutex on which to acquire the lock.</span>
00103 <span class="comment"> */</span>
00104 APR_DECLARE(apr_status_t) apr_proc_mutex_lock(apr_proc_mutex_t *mutex);
00105 <span class="comment"></span>
00106 <span class="comment">/**</span>
00107 <span class="comment"> * Attempt to acquire the lock for the given mutex. If the mutex has already</span>
00108 <span class="comment"> * been acquired, the call returns immediately with APR_EBUSY. Note: it</span>
00109 <span class="comment"> * is important that the APR_STATUS_IS_EBUSY(s) macro be used to determine</span>
00110 <span class="comment"> * if the return value was APR_EBUSY, for portability reasons.</span>
00111 <span class="comment"> * @param mutex the mutex on which to attempt the lock acquiring.</span>
00112 <span class="comment"> */</span>
00113 APR_DECLARE(apr_status_t) apr_proc_mutex_trylock(apr_proc_mutex_t *mutex);
00114 <span class="comment"></span>
00115 <span class="comment">/**</span>
00116 <span class="comment"> * Release the lock for the given mutex.</span>
00117 <span class="comment"> * @param mutex the mutex from which to release the lock.</span>
00118 <span class="comment"> */</span>
00119 APR_DECLARE(apr_status_t) apr_proc_mutex_unlock(apr_proc_mutex_t *mutex);
00120 <span class="comment"></span>
00121 <span class="comment">/**</span>
00122 <span class="comment"> * Destroy the mutex and free the memory associated with the lock.</span>
00123 <span class="comment"> * @param mutex the mutex to destroy.</span>
00124 <span class="comment"> */</span>
00125 APR_DECLARE(apr_status_t) apr_proc_mutex_destroy(apr_proc_mutex_t *mutex);
00126 <span class="comment"></span>
00127 <span class="comment">/**</span>
00128 <span class="comment"> * Destroy the mutex and free the memory associated with the lock.</span>
00129 <span class="comment"> * @param mutex the mutex to destroy.</span>
00130 <span class="comment"> * @note This function is generally used to kill a cleanup on an already</span>
00131 <span class="comment"> * created mutex</span>
00132 <span class="comment"> */</span>
00133 APR_DECLARE(apr_status_t) apr_proc_mutex_cleanup(<span class="keywordtype">void</span> *mutex);
00134 <span class="comment"></span>
00135 <span class="comment">/**</span>
00136 <span class="comment"> * Return the name of the lockfile for the mutex, or NULL</span>
00137 <span class="comment"> * if the mutex doesn't use a lock file</span>
00138 <span class="comment"> */</span>
00139
00140 APR_DECLARE(const <span class="keywordtype">char</span> *) apr_proc_mutex_lockfile(apr_proc_mutex_t *mutex);
00141 <span class="comment"></span>
00142 <span class="comment">/**</span>
00143 <span class="comment"> * Display the name of the mutex, as it relates to the actual method used.</span>
00144 <span class="comment"> * This matches the valid options for Apache's AcceptMutex directive</span>
00145 <span class="comment"> * @param mutex the name of the mutex</span>
00146 <span class="comment"> */</span>
00147 APR_DECLARE(const <span class="keywordtype">char</span> *) apr_proc_mutex_name(apr_proc_mutex_t *mutex);
00148 <span class="comment"></span>
00149 <span class="comment">/**</span>
00150 <span class="comment"> * Display the name of the default mutex: APR_LOCK_DEFAULT</span>
00151 <span class="comment"> */</span>
00152 APR_DECLARE(const <span class="keywordtype">char</span> *) apr_proc_mutex_defname(<span class="keywordtype">void</span>);
00153 <span class="comment"></span>
00154 <span class="comment">/**</span>
00155 <span class="comment"> * Get the pool used by this proc_mutex.</span>
00156 <span class="comment"> * @return apr_pool_t the pool</span>
00157 <span class="comment"> */</span>
00158 APR_POOL_DECLARE_ACCESSOR(proc_mutex);
00159 <span class="comment"></span>
00160 <span class="comment">/** @} */</span>
00161
00162 #ifdef __cplusplus
00163 }
00164 #endif
00165
00166 #endif <span class="comment">/* ! APR_PROC_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="../../../www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.7 </small></address>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -