diff options
Diffstat (limited to 'include/ap_provider.h')
-rw-r--r-- | include/ap_provider.h | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/include/ap_provider.h b/include/ap_provider.h new file mode 100644 index 0000000..0a6c10c --- /dev/null +++ b/include/ap_provider.h @@ -0,0 +1,100 @@ +/* Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @file ap_provider.h + * @brief Apache Provider API + * + * @defgroup APACHE_CORE_PROVIDER Provider API + * @ingroup APACHE_CORE + * @{ + */ + +#ifndef AP_PROVIDER_H +#define AP_PROVIDER_H + +#include "ap_config.h" + +#ifdef __cplusplus +extern "C" { +#endif + +typedef struct { + const char *provider_name; +} ap_list_provider_names_t; + +typedef struct { + const char *provider_group; + const char *provider_version; +} ap_list_provider_groups_t; + +/** + * This function is used to register a provider with the global + * provider pool. + * @param pool The pool to create any storage from + * @param provider_group The group to store the provider in + * @param provider_name The name for this provider + * @param provider_version The version for this provider + * @param provider Opaque structure for this provider + * @return APR_SUCCESS if all went well + */ +AP_DECLARE(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 retrieve a provider from the global + * provider pool. + * @param provider_group The group to look for this provider in + * @param provider_name The name for the provider + * @param provider_version The version for the provider + * @return provider pointer to provider if found, NULL otherwise + */ +AP_DECLARE(void *) ap_lookup_provider(const char *provider_group, + const char *provider_name, + const char *provider_version); + +/** + * This function is used to retrieve a list (array) of provider + * names from the specified group with the specified version. + * @param pool The pool to create any storage from + * @param provider_group The group to look for this provider in + * @param provider_version The version for the provider + * @return pointer to array of ap_list_provider_names_t of provider names (could be empty) + */ + +AP_DECLARE(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 groups and versions + * @param pool The pool to create any storage from + * @return pointer to array of ap_list_provider_groups_t of provider groups + * and versions (could be empty) + */ + +AP_DECLARE(apr_array_header_t *) ap_list_provider_groups(apr_pool_t *pool); + + +#ifdef __cplusplus +} +#endif + +#endif +/** @} */ |