| /* ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2000-2003 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Apache" and "Apache Software Foundation" must |
| * not be used to endorse or promote products derived from this |
| * software without prior written permission. For written |
| * permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * nor may "Apache" appear in their name, without prior written |
| * permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| * |
| * Portions of this software are based upon public domain software |
| * originally written at the National Center for Supercomputing Applications, |
| * University of Illinois, Urbana-Champaign. |
| */ |
| |
| #ifndef APR_QUEUE_H |
| #define APR_QUEUE_H |
| |
| #if APR_HAS_THREADS |
| /** |
| * @file apr_queue.h |
| * @brief Thread Safe FIFO bounded queue |
| * @note Since most implementations of the queue are backed by a condition |
| * variable implementation, it isn't available on systems without threads. |
| * Although condition variables are some times available without threads. |
| */ |
| |
| #include "apu.h" |
| #include "apr_errno.h" |
| #include "apr_pools.h" |
| |
| #ifdef __cplusplus |
| extern "C" { |
| #endif /* __cplusplus */ |
| |
| /** |
| * @defgroup APR_Util_FIFO Thread Safe FIFO bounded queue |
| * @ingroup APR_Util |
| * @{ |
| */ |
| |
| /** |
| * opaque structure |
| */ |
| typedef struct apr_queue_t apr_queue_t; |
| |
| /** |
| * create a FIFO queue |
| * @param queue The new queue |
| * @param queue_capacity maximum size of the queue |
| * @param a pool to allocate queue from |
| */ |
| APU_DECLARE(apr_status_t) apr_queue_create(apr_queue_t **queue, |
| unsigned int queue_capacity, |
| apr_pool_t *a); |
| |
| /** |
| * push/add a object to the queue, blocking if the queue is already full |
| * |
| * @param queue the queue |
| * @param data the data |
| * @returns APR_EINTR the blocking was interrupted (try again) |
| * @returns APR_EOF the queue has been terminated |
| * @returns APR_SUCCESS on a successfull push |
| */ |
| APU_DECLARE(apr_status_t) apr_queue_push(apr_queue_t *queue, void *data); |
| |
| /** |
| * pop/get an object from the queue, blocking if the queue is already empty |
| * |
| * @param queue the queue |
| * @param data the data |
| * @returns APR_EINTR the blocking was interrupted (try again) |
| * @returns APR_EOF if the queue has been terminated |
| * @returns APR_SUCCESS on a successfull pop |
| */ |
| APU_DECLARE(apr_status_t) apr_queue_pop(apr_queue_t *queue, void **data); |
| |
| /** |
| * push/add a object to the queue, returning immediatly if the queue is full |
| * |
| * @param queue the queue |
| * @param data the data |
| * @returns APR_EINTR the blocking operation was interrupted (try again) |
| * @returns APR_EAGAIN the queue is full |
| * @returns APR_EOF the queue has been terminated |
| * @returns APR_SUCCESS on a successfull push |
| */ |
| APU_DECLARE(apr_status_t) apr_queue_trypush(apr_queue_t *queue, void *data); |
| |
| /** |
| * pop/get an object to the queue, returning immediatly if the queue is empty |
| * |
| * @param queue the queue |
| * @param data the data |
| * @returns APR_EINTR the blocking operation was interrupted (try again) |
| * @returns APR_EAGAIN the queue is empty |
| * @returns APR_EOF the queue has been terminated |
| * @returns APR_SUCCESS on a successfull push |
| */ |
| APU_DECLARE(apr_status_t) apr_queue_trypop(apr_queue_t *queue, void **data); |
| |
| /** |
| * returns the size of the queue. |
| * |
| * @warning this is not threadsafe, and is intended for reporting/monitoring |
| * of the queue. |
| * @param queue the queue |
| * @returns the size of the queue |
| */ |
| APU_DECLARE(unsigned int) apr_queue_size(apr_queue_t *queue); |
| |
| /** |
| * interrupt all the threads blocking on this queue. |
| * |
| * @param queue the queue |
| */ |
| APU_DECLARE(apr_status_t) apr_queue_interrupt_all(apr_queue_t *queue); |
| |
| /** |
| * terminate all queue, sendinging a interupt to all the |
| * blocking threads |
| * |
| * @param queue the queue |
| */ |
| APU_DECLARE(apr_status_t) apr_queue_term(apr_queue_t *queue); |
| |
| #ifdef __cplusplus |
| } |
| #endif |
| |
| /** @} */ |
| |
| #endif /* APR_HAS_THREADS */ |
| |
| #endif /* APRQUEUE_H */ |