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

apr_reslist.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 
00055 #ifndef APR_RESLIST_H
00056 #define APR_RESLIST_H
00057 
00063 #include "apr.h"
00064 #include "apu.h"
00065 #include "apr_pools.h"
00066 #include "apr_errno.h"
00067 #include "apr_time.h"
00068 
00069 #if APR_HAS_THREADS
00070 
00077 #ifdef __cplusplus
00078 extern "C" {
00079 #endif /* __cplusplus */
00080 
00082 typedef struct apr_reslist_t apr_reslist_t;
00083 
00084 /* Generic constructor called by resource list when it needs to create a
00085  * resource.
00086  * @param resource opaque resource
00087  * @param param flags
00088  * @param pool  Pool
00089  */
00090 typedef apr_status_t (*apr_reslist_constructor)(void **resource, void *params,
00091                                                 apr_pool_t *pool);
00092 
00093 /* Generic destructor called by resource list when it needs to destroy a
00094  * resource.
00095  * @param resource opaque resource
00096  * @param param flags
00097  * @param pool  Pool
00098  */
00099 typedef apr_status_t (*apr_reslist_destructor)(void *resource, void *params,
00100                                                apr_pool_t *pool);
00101 
00121 APU_DECLARE(apr_status_t) apr_reslist_create(apr_reslist_t **reslist,
00122                                              int min, int smax, int hmax,
00123                                              apr_interval_time_t ttl,
00124                                              apr_reslist_constructor con,
00125                                              apr_reslist_destructor de,
00126                                              void *params,
00127                                              apr_pool_t *pool);
00128 
00137 APU_DECLARE(apr_status_t) apr_reslist_destroy(apr_reslist_t *reslist);
00138 
00144 APU_DECLARE(apr_status_t) apr_reslist_acquire(apr_reslist_t *reslist,
00145                                               void **resource);
00146 
00150 APU_DECLARE(apr_status_t) apr_reslist_release(apr_reslist_t *reslist,
00151                                               void *resource);
00152 
00153 #ifdef __cplusplus
00154 }
00155 #endif
00156 
00159 #endif  /* APR_HAS_THREADS */
00160 
00161 #endif  /* ! APR_RESLIST_H */

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