Apache2
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Provider API
Collaboration diagram for Provider API:

Data Structures

struct  ap_list_provider_names_t
 
struct  ap_list_provider_groups_t
 

Functions

apr_status_t ap_register_provider (apr_pool_t *pool, const char *provider_group, const char *provider_name, const char *provider_version, const void *provider)
 
voidap_lookup_provider (const char *provider_group, const char *provider_name, const char *provider_version)
 
apr_array_header_tap_list_provider_names (apr_pool_t *pool, const char *provider_group, const char *provider_version)
 
apr_array_header_tap_list_provider_groups (apr_pool_t *pool)
 

Detailed Description

Function Documentation

apr_array_header_t* ap_list_provider_groups ( apr_pool_t pool)

This function is used to retrieve a list (array) of provider groups and versions

Parameters
poolThe pool to create any storage from
Returns
pointer to array of ap_list_provider_groups_t of provider groups and versions (could be empty)
apr_array_header_t* ap_list_provider_names ( apr_pool_t pool,
const char *  provider_group,
const char *  provider_version 
)

This function is used to retrieve a list (array) of provider names from the specified group with the specified version.

Parameters
poolThe pool to create any storage from
provider_groupThe group to look for this provider in
provider_versionThe version for the provider
Returns
pointer to array of ap_list_provider_names_t of provider names (could be empty)
void* ap_lookup_provider ( const char *  provider_group,
const char *  provider_name,
const char *  provider_version 
)

This function is used to retrieve a provider from the global provider pool.

Parameters
provider_groupThe group to look for this provider in
provider_nameThe name for the provider
provider_versionThe version for the provider
Returns
provider pointer to provider if found, NULL otherwise
apr_status_t ap_register_provider ( apr_pool_t pool,
const char *  provider_group,
const char *  provider_name,
const char *  provider_version,
const void provider 
)

This function is used to register a provider with the global provider pool.

Parameters
poolThe pool to create any storage from
provider_groupThe group to store the provider in
provider_nameThe name for this provider
provider_versionThe version for this provider
providerOpaque structure for this provider
Returns
APR_SUCCESS if all went well