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 / F277224_apr_queue.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  4KB  |  137 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_QUEUE_H
  17. #define APR_QUEUE_H
  18.  
  19. #if APR_HAS_THREADS
  20. /**
  21.  * @file apr_queue.h
  22.  * @brief Thread Safe FIFO bounded queue
  23.  * @note Since most implementations of the queue are backed by a condition
  24.  * variable implementation, it isn't available on systems without threads.
  25.  * Although condition variables are some times available without threads.
  26.  */
  27.  
  28. #include "apu.h"
  29. #include "apr_errno.h"
  30. #include "apr_pools.h"
  31.  
  32. #ifdef __cplusplus
  33. extern "C" {
  34. #endif /* __cplusplus */
  35.  
  36. /**
  37.  * @defgroup APR_Util_FIFO Thread Safe FIFO bounded queue
  38.  * @ingroup APR_Util
  39.  * @{
  40.  */
  41.  
  42. /**
  43.  * opaque structure
  44.  */
  45. typedef struct apr_queue_t apr_queue_t;
  46.  
  47. /** 
  48.  * create a FIFO queue
  49.  * @param queue The new queue
  50.  * @param queue_capacity maximum size of the queue
  51.  * @param a pool to allocate queue from
  52.  */
  53. APU_DECLARE(apr_status_t) apr_queue_create(apr_queue_t **queue, 
  54.                                            unsigned int queue_capacity, 
  55.                                            apr_pool_t *a);
  56.  
  57. /**
  58.  * push/add a object to the queue, blocking if the queue is already full
  59.  *
  60.  * @param queue the queue
  61.  * @param data the data
  62.  * @returns APR_EINTR the blocking was interrupted (try again)
  63.  * @returns APR_EOF the queue has been terminated
  64.  * @returns APR_SUCCESS on a successfull push
  65.  */
  66. APU_DECLARE(apr_status_t) apr_queue_push(apr_queue_t *queue, void *data);
  67.  
  68. /**
  69.  * pop/get an object from the queue, blocking if the queue is already empty
  70.  *
  71.  * @param queue the queue
  72.  * @param data the data
  73.  * @returns APR_EINTR the blocking was interrupted (try again)
  74.  * @returns APR_EOF if the queue has been terminated
  75.  * @returns APR_SUCCESS on a successfull pop
  76.  */
  77. APU_DECLARE(apr_status_t) apr_queue_pop(apr_queue_t *queue, void **data);
  78.  
  79. /**
  80.  * push/add a object to the queue, returning immediatly if the queue is full
  81.  *
  82.  * @param queue the queue
  83.  * @param data the data
  84.  * @returns APR_EINTR the blocking operation was interrupted (try again)
  85.  * @returns APR_EAGAIN the queue is full
  86.  * @returns APR_EOF the queue has been terminated
  87.  * @returns APR_SUCCESS on a successfull push
  88.  */
  89. APU_DECLARE(apr_status_t) apr_queue_trypush(apr_queue_t *queue, void *data);
  90.  
  91. /**
  92.  * pop/get an object to the queue, returning immediatly if the queue is empty
  93.  *
  94.  * @param queue the queue
  95.  * @param data the data
  96.  * @returns APR_EINTR the blocking operation was interrupted (try again)
  97.  * @returns APR_EAGAIN the queue is empty
  98.  * @returns APR_EOF the queue has been terminated
  99.  * @returns APR_SUCCESS on a successfull push
  100.  */
  101. APU_DECLARE(apr_status_t) apr_queue_trypop(apr_queue_t *queue, void **data);
  102.  
  103. /**
  104.  * returns the size of the queue.
  105.  *
  106.  * @warning this is not threadsafe, and is intended for reporting/monitoring
  107.  * of the queue.
  108.  * @param queue the queue
  109.  * @returns the size of the queue
  110.  */
  111. APU_DECLARE(unsigned int) apr_queue_size(apr_queue_t *queue);
  112.  
  113. /**
  114.  * interrupt all the threads blocking on this queue.
  115.  *
  116.  * @param queue the queue
  117.  */
  118. APU_DECLARE(apr_status_t) apr_queue_interrupt_all(apr_queue_t *queue);
  119.  
  120. /**
  121.  * terminate all queue, sendinging a interupt to all the
  122.  * blocking threads
  123.  *
  124.  * @param queue the queue
  125.  */
  126. APU_DECLARE(apr_status_t) apr_queue_term(apr_queue_t *queue);
  127.  
  128. #ifdef __cplusplus
  129. }
  130. #endif
  131.  
  132. /** @} */
  133.  
  134. #endif /* APR_HAS_THREADS */
  135.  
  136. #endif /* APRQUEUE_H */
  137.