home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277207_apr_global_mutex.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  6KB  |  153 lines
  1. /* Copyright 2000-2004 The Apache Software Foundation
  2.  *
  3.  * Licensed under the Apache License, Version 2.0 (the "License");
  4.  * you may not use this file except in compliance with the License.
  5.  * You may obtain a copy of the License at
  6.  *
  7.  *     http://www.apache.org/licenses/LICENSE-2.0
  8.  *
  9.  * Unless required by applicable law or agreed to in writing, software
  10.  * distributed under the License is distributed on an "AS IS" BASIS,
  11.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12.  * See the License for the specific language governing permissions and
  13.  * limitations under the License.
  14.  */
  15.  
  16. #ifndef APR_GLOBAL_MUTEX_H
  17. #define APR_GLOBAL_MUTEX_H
  18.  
  19. /**
  20.  * @file apr_global_mutex.h
  21.  * @brief APR Global Locking Routines
  22.  */
  23.  
  24. #include "apr.h"
  25. #include "apr_proc_mutex.h"    /* only for apr_lockmech_e */
  26. #include "apr_pools.h"
  27. #include "apr_errno.h"
  28. #if APR_PROC_MUTEX_IS_GLOBAL
  29. #include "apr_proc_mutex.h"
  30. #endif
  31.  
  32. #ifdef __cplusplus
  33. extern "C" {
  34. #endif /* __cplusplus */
  35.  
  36. /**
  37.  * @defgroup APR_GlobalMutex Global Locking Routines
  38.  * @ingroup APR 
  39.  * @{
  40.  */
  41.  
  42. #if !APR_PROC_MUTEX_IS_GLOBAL || defined(DOXYGEN)
  43.  
  44. /** Opaque global mutex structure. */
  45. typedef struct apr_global_mutex_t apr_global_mutex_t;
  46.  
  47. /*   Function definitions */
  48.  
  49. /**
  50.  * Create and initialize a mutex that can be used to synchronize both
  51.  * processes and threads. Note: There is considerable overhead in using
  52.  * this API if only cross-process or cross-thread mutual exclusion is
  53.  * required. See apr_proc_mutex.h and apr_thread_mutex.h for more
  54.  * specialized lock routines.
  55.  * @param mutex the memory address where the newly created mutex will be
  56.  *        stored.
  57.  * @param fname A file name to use if the lock mechanism requires one.  This
  58.  *        argument should always be provided.  The lock code itself will
  59.  *        determine if it should be used.
  60.  * @param mech The mechanism to use for the interprocess lock, if any; one of
  61.  * <PRE>
  62.  *            APR_LOCK_FCNTL
  63.  *            APR_LOCK_FLOCK
  64.  *            APR_LOCK_SYSVSEM
  65.  *            APR_LOCK_POSIXSEM
  66.  *            APR_LOCK_PROC_PTHREAD
  67.  *            APR_LOCK_DEFAULT     pick the default mechanism for the platform
  68.  * </PRE>
  69.  * @param pool the pool from which to allocate the mutex.
  70.  * @warning Check APR_HAS_foo_SERIALIZE defines to see if the platform supports
  71.  *          APR_LOCK_foo.  Only APR_LOCK_DEFAULT is portable.
  72.  */
  73. APR_DECLARE(apr_status_t) apr_global_mutex_create(apr_global_mutex_t **mutex,
  74.                                                   const char *fname,
  75.                                                   apr_lockmech_e mech,
  76.                                                   apr_pool_t *pool);
  77.  
  78. /**
  79.  * Re-open a mutex in a child process.
  80.  * @param mutex The newly re-opened mutex structure.
  81.  * @param fname A file name to use if the mutex mechanism requires one.  This
  82.  *              argument should always be provided.  The mutex code itself will
  83.  *              determine if it should be used.  This filename should be the 
  84.  *              same one that was passed to apr_global_mutex_create().
  85.  * @param pool The pool to operate on.
  86.  * @remark This function must be called to maintain portability, even
  87.  *         if the underlying lock mechanism does not require it.
  88.  */
  89. APR_DECLARE(apr_status_t) apr_global_mutex_child_init(
  90.                               apr_global_mutex_t **mutex,
  91.                               const char *fname,
  92.                               apr_pool_t *pool);
  93.  
  94. /**
  95.  * Acquire the lock for the given mutex. If the mutex is already locked,
  96.  * the current thread will be put to sleep until the lock becomes available.
  97.  * @param mutex the mutex on which to acquire the lock.
  98.  */
  99. APR_DECLARE(apr_status_t) apr_global_mutex_lock(apr_global_mutex_t *mutex);
  100.  
  101. /**
  102.  * Attempt to acquire the lock for the given mutex. If the mutex has already
  103.  * been acquired, the call returns immediately with APR_EBUSY. Note: it
  104.  * is important that the APR_STATUS_IS_EBUSY(s) macro be used to determine
  105.  * if the return value was APR_EBUSY, for portability reasons.
  106.  * @param mutex the mutex on which to attempt the lock acquiring.
  107.  */
  108. APR_DECLARE(apr_status_t) apr_global_mutex_trylock(apr_global_mutex_t *mutex);
  109.  
  110. /**
  111.  * Release the lock for the given mutex.
  112.  * @param mutex the mutex from which to release the lock.
  113.  */
  114. APR_DECLARE(apr_status_t) apr_global_mutex_unlock(apr_global_mutex_t *mutex);
  115.  
  116. /**
  117.  * Destroy the mutex and free the memory associated with the lock.
  118.  * @param mutex the mutex to destroy.
  119.  */
  120. APR_DECLARE(apr_status_t) apr_global_mutex_destroy(apr_global_mutex_t *mutex);
  121.  
  122. /**
  123.  * Get the pool used by this global_mutex.
  124.  * @return apr_pool_t the pool
  125.  */
  126. APR_POOL_DECLARE_ACCESSOR(global_mutex);
  127.  
  128. #else /* APR_PROC_MUTEX_IS_GLOBAL */
  129.  
  130. /* Some platforms [e.g. Win32] have cross process locks that are truly
  131.  * global locks, since there isn't the concept of cross-process locks.
  132.  * Define these platforms in terms of an apr_proc_mutex_t.
  133.  */
  134.  
  135. #define apr_global_mutex_t          apr_proc_mutex_t
  136. #define apr_global_mutex_create     apr_proc_mutex_create
  137. #define apr_global_mutex_child_init apr_proc_mutex_child_init
  138. #define apr_global_mutex_lock       apr_proc_mutex_lock
  139. #define apr_global_mutex_trylock    apr_proc_mutex_trylock
  140. #define apr_global_mutex_unlock     apr_proc_mutex_unlock
  141. #define apr_global_mutex_destroy    apr_proc_mutex_destroy
  142. #define apr_global_mutex_pool_get   apr_proc_mutex_pool_get
  143.  
  144. #endif
  145.  
  146. /** @} */
  147.  
  148. #ifdef __cplusplus
  149. }
  150. #endif
  151.  
  152. #endif  /* ndef APR_GLOBAL_MUTEX_H */
  153.