mod_dbd.h revision 137e484e5f984ceff1102e1212dda8ac0413231a
/* 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
*
*
* 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 mod_dbd.h
* @brief Database Access Extension Module for Apache
*
* Overview of what this is and does:
* or
*
* @defgroup MOD_DBD mod_dbd
* @ingroup APACHE_MODS
* @{
*/
#ifndef DBD_H
#define DBD_H
/* Create a set of DBD_DECLARE(type), DBD_DECLARE_NONSTD(type) and
* DBD_DECLARE_DATA with appropriate export and import tags for the platform
*/
#if !defined(WIN32)
#define DBD_DECLARE_DATA
#elif defined(DBD_DECLARE_STATIC)
#define DBD_DECLARE_DATA
#elif defined(DBD_DECLARE_EXPORT)
#else
#endif
#include <httpd.h>
#include <apr_optional.h>
#include <apr_hash.h>
#include <apr_hooks.h>
typedef struct {
const char *name;
const char *params;
int persist;
#if APR_HAS_THREADS
int nmin;
int nkeep;
int nmax;
int exptime;
int set;
#endif
} dbd_cfg_t;
typedef struct {
const apr_dbd_driver_t *driver;
} ap_dbd_t;
/* Export functions to access the database */
/* acquire a connection that MUST be explicitly closed.
* Returns NULL on error
*/
/* release a connection acquired with ap_dbd_open */
/* acquire a connection that will have the lifetime of a request
* and MUST NOT be explicitly closed. Return NULL on error.
* This is the preferred function for most applications.
*/
/* acquire a connection that will have the lifetime of a connection
* and MUST NOT be explicitly closed. Return NULL on error.
* This is the preferred function for most applications.
*/
/* Prepare a statement for use by a client module during
* the server startup/configuration phase. Can't be called
* after the server has created its children (use apr_dbd_*).
*/
/* Also export them as optional functions for modules that prefer it */
#endif
/** @} */