Apache Portable Runtime Utility Library
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
apr_reslist.h
Go to the documentation of this file.
1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2  * contributor license agreements. See the NOTICE file distributed with
3  * this work for additional information regarding copyright ownership.
4  * The ASF licenses this file to You under the Apache License, Version 2.0
5  * (the "License"); you may not use this file except in compliance with
6  * the License. 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 
25 #include "apr.h"
26 #include "apu.h"
27 #include "apr_pools.h"
28 #include "apr_errno.h"
29 #include "apr_time.h"
30 
37 #ifdef __cplusplus
38 extern "C" {
39 #endif /* __cplusplus */
40 
43 
44 /* Generic constructor called by resource list when it needs to create a
45  * resource.
46  * @param resource opaque resource
47  * @param param flags
48  * @param pool Pool
49  */
50 typedef apr_status_t (*apr_reslist_constructor)(void **resource, void *params,
51  apr_pool_t *pool);
52 
53 /* Generic destructor called by resource list when it needs to destroy a
54  * resource.
55  * @param resource opaque resource
56  * @param param flags
57  * @param pool Pool
58  */
59 typedef apr_status_t (*apr_reslist_destructor)(void *resource, void *params,
60  apr_pool_t *pool);
61 
62 /* Cleanup order modes */
63 #define APR_RESLIST_CLEANUP_DEFAULT 0
64 #define APR_RESLIST_CLEANUP_FIRST 1
89 APU_DECLARE(apr_status_t) apr_reslist_create(apr_reslist_t **reslist,
90  int min, int smax, int hmax,
91  apr_interval_time_t ttl,
92  apr_reslist_constructor con,
93  apr_reslist_destructor de,
94  void *params,
95  apr_pool_t *pool);
96 
108 APU_DECLARE(apr_status_t) apr_reslist_destroy(apr_reslist_t *reslist);
109 
115 APU_DECLARE(apr_status_t) apr_reslist_acquire(apr_reslist_t *reslist,
116  void **resource);
117 
121 APU_DECLARE(apr_status_t) apr_reslist_release(apr_reslist_t *reslist,
122  void *resource);
123 
130 APU_DECLARE(void) apr_reslist_timeout_set(apr_reslist_t *reslist,
131  apr_interval_time_t timeout);
132 
137 APU_DECLARE(apr_uint32_t) apr_reslist_acquired_count(apr_reslist_t *reslist);
138 
144 APU_DECLARE(apr_status_t) apr_reslist_invalidate(apr_reslist_t *reslist,
145  void *resource);
146 
152 APU_DECLARE(apr_status_t) apr_reslist_maintain(apr_reslist_t *reslist);
153 
167 APU_DECLARE(void) apr_reslist_cleanup_order_set(apr_reslist_t *reslist,
168  apr_uint32_t mode);
169 
170 #ifdef __cplusplus
171 }
172 #endif
173 
176 #endif /* ! APR_RESLIST_H */