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)
void *	ap_lookup_provider (const char *provider_group, const char *provider_name, const char *provider_version)
apr_array_header_t *	ap_list_provider_names (apr_pool_t *pool, const char *provider_group, const char *provider_version)
apr_array_header_t *	ap_list_provider_groups (apr_pool_t *pool)

Detailed Description

Function Documentation

ap_list_provider_groups()

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

pool	The pool to create any storage from

Returns

pointer to array of ap_list_provider_groups_t of provider groups and versions (could be empty)

ap_list_provider_names()

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

pool	The pool to create any storage from
provider_group	The group to look for this provider in
provider_version	The version for the provider

Returns

pointer to array of ap_list_provider_names_t of provider names (could be empty)

ap_lookup_provider()

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_group	The group to look for this provider in
provider_name	The name for the provider
provider_version	The version for the provider

Returns

provider pointer to provider if found, NULL otherwise

ap_register_provider()

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

pool	The pool to create any storage from
provider_group	The group to store the provider in
provider_name	The name for this provider
provider_version	The version for this provider
provider	Opaque structure for this provider

Returns

APR_SUCCESS if all went well