granicus.if.org Git - apache/blob - include/ap_provider.h

   1 /* Copyright 2002-2004 The Apache Software Foundation
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 #ifndef AP_PROVIDER_H
  17 #define AP_PROVIDER_H
  18
  19 #include "ap_config.h"
  20
  21 /**
  22  * @package Provider API
  23  */
  24
  25 /**
  26  * This function is used to register a provider with the global
  27  * provider pool.
  28  * @param pool The pool to create any storage from
  29  * @param provider_group The group to store the provider in
  30  * @param provider_name The name for this provider
  31  * @param provider_version The version for this provider
  32  * @param provider Opaque structure for this provider
  33  * @return APR_SUCCESS if all went well
  34  */
  35 AP_DECLARE(apr_status_t) ap_register_provider(apr_pool_t *pool,
  36                                               const char *provider_group,
  37                                               const char *provider_name,
  38                                               const char *provider_version,
  39                                               const void *provider);
  40
  41 /**
  42  * This function is used to retrieve a provider from the global
  43  * provider pool.
  44  * @param provider_group The group to look for this provider in
  45  * @param provider_name The name for the provider
  46  * @param provider_version The version for the provider
  47  * @return provider pointer to provider if found, NULL otherwise
  48  */
  49 AP_DECLARE(void *) ap_lookup_provider(const char *provider_group,
  50                                       const char *provider_name,
  51                                       const char *provider_version);
  52
  53 #endif