Main Page | Modules | Namespace List | Data Structures | File List | Data Fields | Globals | Related Pages

apr_queue.h

Go to the documentation of this file.
00001 /* ====================================================================
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Apache" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation.  For more
00051  * information on the Apache Software Foundation, please see
00052  * <http://www.apache.org/>.
00053  *
00054  * Portions of this software are based upon public domain software
00055  * originally written at the National Center for Supercomputing Applications,
00056  * University of Illinois, Urbana-Champaign.
00057  */
00058 
00059 #ifndef APR_QUEUE_H
00060 #define APR_QUEUE_H
00061 
00062 #if APR_HAS_THREADS
00063 
00071 #include "apu.h"
00072 #include "apr_errno.h"
00073 #include "apr_pools.h"
00074 
00075 #ifdef __cplusplus
00076 extern "C" {
00077 #endif /* __cplusplus */
00078 
00088 typedef struct apr_queue_t apr_queue_t;
00089 
00096 APU_DECLARE(apr_status_t) apr_queue_create(apr_queue_t **queue, 
00097                                            unsigned int queue_capacity, 
00098                                            apr_pool_t *a);
00099 
00109 APU_DECLARE(apr_status_t) apr_queue_push(apr_queue_t *queue, void *data);
00110 
00120 APU_DECLARE(apr_status_t) apr_queue_pop(apr_queue_t *queue, void **data);
00121 
00132 APU_DECLARE(apr_status_t) apr_queue_trypush(apr_queue_t *queue, void *data);
00133 
00144 APU_DECLARE(apr_status_t) apr_queue_trypop(apr_queue_t *queue, void **data);
00145 
00154 APU_DECLARE(unsigned int) apr_queue_size(apr_queue_t *queue);
00155 
00161 APU_DECLARE(apr_status_t) apr_queue_interrupt_all(apr_queue_t *queue);
00162 
00169 APU_DECLARE(apr_status_t) apr_queue_term(apr_queue_t *queue);
00170 
00171 #ifdef __cplusplus
00172 }
00173 #endif
00174 
00177 #endif /* APR_HAS_THREADS */
00178 
00179 #endif /* APRQUEUE_H */

Generated on Tue Dec 7 18:34:56 2010 for Apache Portable Runtime Utility Library by  doxygen 1.3.9.1