rubbos/app/apache2/include/apr_reslist.h

   1 /* Copyright 2000-2005 The Apache Software Foundation or its licensors, as
   2  * applicable.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef APR_RESLIST_H
  18 #define APR_RESLIST_H
  19
  20 /**
  21  * @file apr_reslist.h
  22  * @brief APR-UTIL Resource List Routines
  23  */
  24
  25 #include "apr.h"
  26 #include "apu.h"
  27 #include "apr_pools.h"
  28 #include "apr_errno.h"
  29 #include "apr_time.h"
  30
  31 #if APR_HAS_THREADS
  32
  33 /**
  34  * @defgroup APR_Util_RL Resource List Routines
  35  * @ingroup APR_Util
  36  * @{
  37  */
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif /* __cplusplus */
  42
  43 /** Opaque resource list object */
  44 typedef struct apr_reslist_t apr_reslist_t;
  45
  46 /* Generic constructor called by resource list when it needs to create a
  47  * resource.
  48  * @param resource opaque resource
  49  * @param param flags
  50  * @param pool  Pool
  51  */
  52 typedef apr_status_t (*apr_reslist_constructor)(void **resource, void *params,
  53                                                 apr_pool_t *pool);
  54
  55 /* Generic destructor called by resource list when it needs to destroy a
  56  * resource.
  57  * @param resource opaque resource
  58  * @param param flags
  59  * @param pool  Pool
  60  */
  61 typedef apr_status_t (*apr_reslist_destructor)(void *resource, void *params,
  62                                                apr_pool_t *pool);
  63
  64 /**
  65  * Create a new resource list with the following parameters:
  66  * @param reslist An address where the pointer to the new resource
  67  *                list will be stored.
  68  * @param pool The pool to use for local storage and management
  69  * @param min Allowed minimum number of available resources. Zero
  70  *            creates new resources only when needed.
  71  * @param smax Resources will be destroyed to meet this maximum
  72  *             restriction as they expire.
  73  * @param hmax Absolute maximum limit on the number of total resources.
  74  * @param ttl If non-zero, sets the maximum amount of time a resource
  75  *               may be available while exceeding the soft limit.
  76  * @param con Constructor routine that is called to create a new resource.
  77  * @param de Destructor routine that is called to destroy an expired resource.
  78  * @param params Passed to constructor and deconstructor
  79  * @param pool The pool from which to create this resoure list. Also the
  80  *             same pool that is passed to the constructor and destructor
  81  *             routines.
  82  */
  83 APU_DECLARE(apr_status_t) apr_reslist_create(apr_reslist_t **reslist,
  84                                              int min, int smax, int hmax,
  85                                              apr_interval_time_t ttl,
  86                                              apr_reslist_constructor con,
  87                                              apr_reslist_destructor de,
  88                                              void *params,
  89                                              apr_pool_t *pool);
  90
  91 /**
  92  * Destroy the given resource list and all resources controlled by
  93  * this list.
  94  * FIXME: Should this block until all resources become available,
  95  *        or maybe just destroy all the free ones, or maybe destroy
  96  *        them even though they might be in use by something else?
  97  * @param reslist The reslist to destroy
  98  */
  99 APU_DECLARE(apr_status_t) apr_reslist_destroy(apr_reslist_t *reslist);
 100
 101 /**
 102  * Retrieve a resource from the list, creating a new one if necessary.
 103  * If we have met our maximum number of resources, we will block
 104  * until one becomes available.
 105  */
 106 APU_DECLARE(apr_status_t) apr_reslist_acquire(apr_reslist_t *reslist,
 107                                               void **resource);
 108
 109 /**
 110  * Return a resource back to the list of available resources.
 111  */
 112 APU_DECLARE(apr_status_t) apr_reslist_release(apr_reslist_t *reslist,
 113                                               void *resource);
 114
 115 /**
 116  * Set the timeout the acquire will wait for a free resource
 117  * when the maximum number of resources is exceeded.
 118  * @param reslist The resource list.
 119  * @param timeout Timeout to wait. The zero waits forewer.
 120  */
 121 APU_DECLARE(void) apr_reslist_timeout_set(apr_reslist_t *reslist,
 122                                           apr_interval_time_t timeout);
 123
 124 /**
 125  * Invalidate a resource in the pool - e.g. a database connection
 126  * that returns a "lost connection" error and can't be restored.
 127  * Use this instead of apr_reslist_release if the resource is bad.
 128  */
 129 APU_DECLARE(apr_status_t) apr_reslist_invalidate(apr_reslist_t *reslist,
 130                                                  void *resource);
 131
 132
 133 #ifdef __cplusplus
 134 }
 135 #endif
 136
 137 /** @} */
 138
 139 #endif  /* APR_HAS_THREADS */
 140
 141 #endif  /* ! APR_RESLIST_H */