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 / F277236_apr_thread_cond.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  5KB  |  128 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_COND_H
  17. #define APR_THREAD_COND_H
  18.  
  19. /**
  20.  * @file apr_thread_cond.h
  21.  * @brief APR Condition Variable Routines
  22.  */
  23.  
  24. #include "apr.h"
  25. #include "apr_pools.h"
  26. #include "apr_errno.h"
  27. #include "apr_time.h"
  28. #include "apr_thread_mutex.h"
  29.  
  30. #ifdef __cplusplus
  31. extern "C" {
  32. #endif /* __cplusplus */
  33.  
  34. #if APR_HAS_THREADS || defined(DOXYGEN)
  35.  
  36. /**
  37.  * @defgroup apr_thread_cond Condition Variable Routines
  38.  * @ingroup APR 
  39.  * @{
  40.  */
  41.  
  42. /** Opaque structure for thread condition variables */
  43. typedef struct apr_thread_cond_t apr_thread_cond_t;
  44.  
  45. /**
  46.  * Create and initialize a condition variable that can be used to signal
  47.  * and schedule threads in a single process.
  48.  * @param cond the memory address where the newly created condition variable
  49.  *        will be stored.
  50.  * @param pool the pool from which to allocate the mutex.
  51.  */
  52. APR_DECLARE(apr_status_t) apr_thread_cond_create(apr_thread_cond_t **cond,
  53.                                                  apr_pool_t *pool);
  54.  
  55. /**
  56.  * Put the active calling thread to sleep until signaled to wake up. Each
  57.  * condition variable must be associated with a mutex, and that mutex must
  58.  * be locked before  calling this function, or the behavior will be
  59.  * undefined. As the calling thread is put to sleep, the given mutex
  60.  * will be simultaneously released; and as this thread wakes up the lock
  61.  * is again simultaneously acquired.
  62.  * @param cond the condition variable on which to block.
  63.  * @param mutex the mutex that must be locked upon entering this function,
  64.  *        is released while the thread is asleep, and is again acquired before
  65.  *        returning from this function.
  66.  */
  67. APR_DECLARE(apr_status_t) apr_thread_cond_wait(apr_thread_cond_t *cond,
  68.                                                apr_thread_mutex_t *mutex);
  69.  
  70. /**
  71.  * Put the active calling thread to sleep until signaled to wake up or
  72.  * the timeout is reached. Each condition variable must be associated
  73.  * with a mutex, and that mutex must be locked before calling this
  74.  * function, or the behavior will be undefined. As the calling thread
  75.  * is put to sleep, the given mutex will be simultaneously released;
  76.  * and as this thread wakes up the lock is again simultaneously acquired.
  77.  * @param cond the condition variable on which to block.
  78.  * @param mutex the mutex that must be locked upon entering this function,
  79.  *        is released while the thread is asleep, and is again acquired before
  80.  *        returning from this function.
  81.  * @param timeout The amount of time in microseconds to wait. This is 
  82.  *        a maximum, not a minimum. If the condition is signaled, we 
  83.  *        will wake up before this time, otherwise the error APR_TIMEUP
  84.  *        is returned.
  85.  */
  86. APR_DECLARE(apr_status_t) apr_thread_cond_timedwait(apr_thread_cond_t *cond,
  87.                                                     apr_thread_mutex_t *mutex,
  88.                                                     apr_interval_time_t timeout);
  89.  
  90. /**
  91.  * Signals a singla thread, if one exists, that is blocking on the given
  92.  * condition variable. That thread is then scheduled to wake up and acquire
  93.  * the associated mutex. Although it is not required, if predictible schedule
  94.  * is desired, that mutex must be locked while calling this function.
  95.  * @param cond the condition variable on which to produce the signal.
  96.  */
  97. APR_DECLARE(apr_status_t) apr_thread_cond_signal(apr_thread_cond_t *cond);
  98.  
  99. /**
  100.  * Signals all threads blocking on the given condition variable.
  101.  * Each thread that was signaled is then schedule to wake up and acquire
  102.  * the associated mutex. This will happen in a serialized manner.
  103.  * @param cond the condition variable on which to produce the broadcast.
  104.  */
  105. APR_DECLARE(apr_status_t) apr_thread_cond_broadcast(apr_thread_cond_t *cond);
  106.  
  107. /**
  108.  * Destroy the condition variable and free the associated memory.
  109.  * @param cond the condition variable to destroy.
  110.  */
  111. APR_DECLARE(apr_status_t) apr_thread_cond_destroy(apr_thread_cond_t *cond);
  112.  
  113. /**
  114.  * Get the pool used by this thread_cond.
  115.  * @return apr_pool_t the pool
  116.  */
  117. APR_POOL_DECLARE_ACCESSOR(thread_cond);
  118.  
  119. #endif /* APR_HAS_THREADS */
  120.  
  121. /** @} */
  122.  
  123. #ifdef __cplusplus
  124. }
  125. #endif
  126.  
  127. #endif  /* ! APR_THREAD_COND_H */
  128.