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 / F277239_apr_thread_rwlock.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  4KB  |  120 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_THREAD_RWLOCK_H
  17. #define APR_THREAD_RWLOCK_H
  18.  
  19. /**
  20.  * @file apr_thread_rwlock.h
  21.  * @brief APR Reader/Writer Lock Routines
  22.  */
  23.  
  24. #include "apr.h"
  25. #include "apr_pools.h"
  26. #include "apr_errno.h"
  27.  
  28. #ifdef __cplusplus
  29. extern "C" {
  30. #endif /* __cplusplus */
  31.  
  32. #if APR_HAS_THREADS
  33.  
  34. /**
  35.  * @defgroup apr_thread_rwlock Reader/Writer Lock Routines
  36.  * @ingroup APR 
  37.  * @{
  38.  */
  39.  
  40. /** Opaque read-write thread-safe lock. */
  41. typedef struct apr_thread_rwlock_t apr_thread_rwlock_t;
  42.  
  43. /**
  44.  * Create and initialize a read-write lock that can be used to synchronize
  45.  * threads.
  46.  * @param rwlock the memory address where the newly created readwrite lock
  47.  *        will be stored.
  48.  * @param pool the pool from which to allocate the mutex.
  49.  */
  50. APR_DECLARE(apr_status_t) apr_thread_rwlock_create(apr_thread_rwlock_t **rwlock,
  51.                                                    apr_pool_t *pool);
  52. /**
  53.  * Acquire a shared-read lock on the given read-write lock. This will allow
  54.  * multiple threads to enter the same critical section while they have acquired
  55.  * the read lock.
  56.  * @param rwlock the read-write lock on which to acquire the shared read.
  57.  */
  58. APR_DECLARE(apr_status_t) apr_thread_rwlock_rdlock(apr_thread_rwlock_t *rwlock);
  59.  
  60. /**
  61.  * Attempt to acquire the shread-read lock on the given read-write lock. This
  62.  * is the same as apr_thread_rwlock_rdlock(), only that the funtion fails
  63.  * if there is another thread holding the write lock, or if there are any
  64.  * write threads blocking on the lock. If the function failes for this case,
  65.  * APR_EBUSY will be returned. Note: it is important that the
  66.  * APR_STATUS_IS_EBUSY(s) macro be used to determine if the return value was
  67.  * APR_EBUSY, for portability reasons.
  68.  * @param rwlock the rwlock on which to attempt the shared read.
  69.  */
  70. APR_DECLARE(apr_status_t) apr_thread_rwlock_tryrdlock(apr_thread_rwlock_t *rwlock);
  71.  
  72. /**
  73.  * Acquire an exclusive-write lock on the given read-write lock. This will
  74.  * allow only one single thread to enter the critical sections. If there
  75.  * are any threads currently holding thee read-lock, this thread is put to
  76.  * sleep until it can have exclusive access to the lock.
  77.  * @param rwlock the read-write lock on which to acquire the exclusive write.
  78.  */
  79. APR_DECLARE(apr_status_t) apr_thread_rwlock_wrlock(apr_thread_rwlock_t *rwlock);
  80.  
  81. /**
  82.  * Attempt to acquire the exclusive-write lock on the given read-write lock. 
  83.  * This is the same as apr_thread_rwlock_wrlock(), only that the funtion fails
  84.  * if there is any other thread holding the lock (for reading or writing),
  85.  * in which case the function will return APR_EBUSY. Note: it is important
  86.  * that the APR_STATUS_IS_EBUSY(s) macro be used to determine if the return
  87.  * value was APR_EBUSY, for portability reasons.
  88.  * @param rwlock the rwlock on which to attempt the exclusive write.
  89.  */
  90. APR_DECLARE(apr_status_t) apr_thread_rwlock_trywrlock(apr_thread_rwlock_t *rwlock);
  91.  
  92. /**
  93.  * Release either the read or write lock currently held by the calling thread
  94.  * associated with the given read-write lock.
  95.  * @param rwlock the read-write lock to be released (unlocked).
  96.  */
  97. APR_DECLARE(apr_status_t) apr_thread_rwlock_unlock(apr_thread_rwlock_t *rwlock);
  98.  
  99. /**
  100.  * Destroy the read-write lock and free the associated memory.
  101.  * @param rwlock the rwlock to destroy.
  102.  */
  103. APR_DECLARE(apr_status_t) apr_thread_rwlock_destroy(apr_thread_rwlock_t *rwlock);
  104.  
  105. /**
  106.  * Get the pool used by this thread_rwlock.
  107.  * @return apr_pool_t the pool
  108.  */
  109. APR_POOL_DECLARE_ACCESSOR(thread_rwlock);
  110.  
  111. #endif  /* APR_HAS_THREADS */
  112.  
  113. /** @} */
  114.  
  115. #ifdef __cplusplus
  116. }
  117. #endif
  118.  
  119. #endif  /* ! APR_THREAD_RWLOCK_H */
  120.