Collaboration diagram for Resource List Routines:

Defines
#define	APR_RESLIST_CLEANUP_DEFAULT 0
#define	APR_RESLIST_CLEANUP_FIRST 1
Typedefs
typedef struct apr_reslist_t	apr_reslist_t
typedef apr_status_t(*	apr_reslist_constructor )(void *resource, void params, apr_pool_t *pool)
typedef apr_status_t(*	apr_reslist_destructor )(void resource, void params, apr_pool_t *pool)
Functions
	APU_DECLARE (apr_status_t) apr_reslist_create(apr_reslist_t **reslist
	APU_DECLARE (void) apr_reslist_timeout_set(apr_reslist_t *reslist
	APU_DECLARE (apr_uint32_t) apr_reslist_acquired_count(apr_reslist_t *reslist)
Variables
int	min
int int	smax
int int int	hmax
int int int apr_interval_time_t	ttl
int int int apr_interval_time_t apr_reslist_constructor	con
int int int apr_interval_time_t apr_reslist_constructor apr_reslist_destructor	de
int int int apr_interval_time_t apr_reslist_constructor apr_reslist_destructor void *	params
int int int apr_interval_time_t apr_reslist_constructor apr_reslist_destructor void apr_pool_t *	pool
void **	resource
apr_interval_time_t	timeout
apr_uint32_t	mode

Define Documentation

#define APR_RESLIST_CLEANUP_DEFAULT 0

default pool cleanup

Definition at line 63 of file apr_reslist.h.

#define APR_RESLIST_CLEANUP_FIRST 1

use pool pre cleanup

Definition at line 64 of file apr_reslist.h.

Typedef Documentation

typedef apr_status_t(* apr_reslist_constructor)(void **resource, void *params, apr_pool_t *pool)

Definition at line 50 of file apr_reslist.h.

typedef apr_status_t(* apr_reslist_destructor)(void *resource, void *params, apr_pool_t *pool)

Definition at line 59 of file apr_reslist.h.

typedef struct apr_reslist_t apr_reslist_t

Opaque resource list object

Definition at line 42 of file apr_reslist.h.

Function Documentation

APU_DECLARE ( apr_status_t )

Create a new resource list with the following parameters:

Parameters:

reslist	An address where the pointer to the new resource list will be stored.
min	Allowed minimum number of available resources. Zero creates new resources only when needed.
smax	Resources will be destroyed during reslist maintenance to meet this maximum restriction as they expire (reach their ttl).
hmax	Absolute maximum limit on the number of total resources.
ttl	If non-zero, sets the maximum amount of time in microseconds an unused resource is valid. Any resource which has exceeded this time will be destroyed, either when encountered by apr_reslist_acquire() or during reslist maintenance.
con	Constructor routine that is called to create a new resource.
de	Destructor routine that is called to destroy an expired resource.
params	Passed to constructor and deconstructor
pool	The pool from which to create this resource list. Also the same pool that is passed to the constructor and destructor routines.

Remarks:: If APR has been compiled without thread support, hmax will be automatically set to 1 and values of min and smax will be forced to 1 for any non-zero value.

Destroy the given resource list and all resources controlled by this list. FIXME: Should this block until all resources become available, or maybe just destroy all the free ones, or maybe destroy them even though they might be in use by something else? Currently it will abort if there are resources that haven't been released, so there is an assumption that all resources have been released to the list before calling this function.

Parameters:

reslist The reslist to destroy

Retrieve a resource from the list, creating a new one if necessary. If we have met our maximum number of resources, we will block until one becomes available.

Return a resource back to the list of available resources.

Invalidate a resource in the pool - e.g. a database connection that returns a "lost connection" error and can't be restored. Use this instead of apr_reslist_release if the resource is bad.

Perform routine maintenance on the resource list. This call may instantiate new resources or expire old resources.

Parameters:

reslist The resource list.

APU_DECLARE ( void )

Set the timeout the acquire will wait for a free resource when the maximum number of resources is exceeded.

Parameters:

reslist	The resource list.
timeout	Timeout to wait. The zero waits forever.

Set reslist cleanup order.

Parameters:

reslist	The resource list.
mode	Cleanup order mode APR_RESLIST_CLEANUP_DEFAULT default pool cleanup order APR_RESLIST_CLEANUP_FIRST use pool pre cleanup

Remarks:: If APR_RESLIST_CLEANUP_FIRST is used the destructors will be called before child pools of the pool used to create the reslist are destroyed. This allows to explicitly destroy the child pools inside reslist destructors.

APU_DECLARE ( apr_uint32_t )

Return the number of outstanding resources.

Parameters:

reslist The resource list.

Creates a crc32 hash used to split keys between servers

Parameters: