rubbos/app/apache2/include/ap_provider.h

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