00001 /* ==================================================================== 00002 * The Apache Software License, Version 1.1 00003 * 00004 * Copyright (c) 2000-2003 The Apache Software Foundation. All rights 00005 * reserved. 00006 * 00007 * Redistribution and use in source and binary forms, with or without 00008 * modification, are permitted provided that the following conditions 00009 * are met: 00010 * 00011 * 1. Redistributions of source code must retain the above copyright 00012 * notice, this list of conditions and the following disclaimer. 00013 * 00014 * 2. Redistributions in binary form must reproduce the above copyright 00015 * notice, this list of conditions and the following disclaimer in 00016 * the documentation and/or other materials provided with the 00017 * distribution. 00018 * 00019 * 3. The end-user documentation included with the redistribution, 00020 * if any, must include the following acknowledgment: 00021 * "This product includes software developed by the 00022 * Apache Software Foundation (http://www.apache.org/)." 00023 * Alternately, this acknowledgment may appear in the software itself, 00024 * if and wherever such third-party acknowledgments normally appear. 00025 * 00026 * 4. The names "Apache" and "Apache Software Foundation" must 00027 * not be used to endorse or promote products derived from this 00028 * software without prior written permission. For written 00029 * permission, please contact apache@apache.org. 00030 * 00031 * 5. Products derived from this software may not be called "Apache", 00032 * nor may "Apache" appear in their name, without prior written 00033 * permission of the Apache Software Foundation. 00034 * 00035 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 00036 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 00037 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 00038 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 00039 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 00040 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 00041 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 00042 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 00043 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 00044 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 00045 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 00046 * SUCH DAMAGE. 00047 * ==================================================================== 00048 * 00049 * This software consists of voluntary contributions made by many 00050 * individuals on behalf of the Apache Software Foundation. For more 00051 * information on the Apache Software Foundation, please see 00052 * <http://www.apache.org/>. 00053 */ 00054 00055 #ifndef APR_DBM_H 00056 #define APR_DBM_H 00057 00058 #include "apu.h" 00059 #include "apr.h" 00060 #include "apr_errno.h" 00061 #include "apr_pools.h" 00062 #include "apr_file_info.h" 00063 00064 #ifdef __cplusplus 00065 extern "C" { 00066 #endif 00067 00080 typedef struct apr_dbm_t apr_dbm_t; 00081 00085 typedef struct 00086 { 00088 char *dptr; 00090 apr_size_t dsize; 00091 } apr_datum_t; 00092 00093 /* modes to open the DB */ 00094 #define APR_DBM_READONLY 1 00095 #define APR_DBM_READWRITE 2 00096 #define APR_DBM_RWCREATE 3 00097 #define APR_DBM_RWTRUNC 4 00124 APU_DECLARE(apr_status_t) apr_dbm_open_ex(apr_dbm_t **dbm, const char* type, 00125 const char *name, 00126 apr_int32_t mode, apr_fileperms_t perm, 00127 apr_pool_t *cntxt); 00128 00129 00146 APU_DECLARE(apr_status_t) apr_dbm_open(apr_dbm_t **dbm, const char *name, 00147 apr_int32_t mode, apr_fileperms_t perm, 00148 apr_pool_t *cntxt); 00149 00154 APU_DECLARE(void) apr_dbm_close(apr_dbm_t *dbm); 00155 00162 APU_DECLARE(apr_status_t) apr_dbm_fetch(apr_dbm_t *dbm, apr_datum_t key, 00163 apr_datum_t *pvalue); 00170 APU_DECLARE(apr_status_t) apr_dbm_store(apr_dbm_t *dbm, apr_datum_t key, 00171 apr_datum_t value); 00172 00179 APU_DECLARE(apr_status_t) apr_dbm_delete(apr_dbm_t *dbm, apr_datum_t key); 00180 00186 APU_DECLARE(int) apr_dbm_exists(apr_dbm_t *dbm, apr_datum_t key); 00187 00193 APU_DECLARE(apr_status_t) apr_dbm_firstkey(apr_dbm_t *dbm, apr_datum_t *pkey); 00194 00200 APU_DECLARE(apr_status_t) apr_dbm_nextkey(apr_dbm_t *dbm, apr_datum_t *pkey); 00201 00207 APU_DECLARE(void) apr_dbm_freedatum(apr_dbm_t *dbm, apr_datum_t data); 00208 00218 APU_DECLARE(char *) apr_dbm_geterror(apr_dbm_t *dbm, int *errcode, 00219 char *errbuf, apr_size_t errbufsize); 00234 APU_DECLARE(apr_status_t) apr_dbm_get_usednames_ex(apr_pool_t *pool, 00235 const char *type, 00236 const char *pathname, 00237 const char **used1, 00238 const char **used2); 00239 00252 APU_DECLARE(void) apr_dbm_get_usednames(apr_pool_t *pool, 00253 const char *pathname, 00254 const char **used1, 00255 const char **used2); 00256 00258 #ifdef __cplusplus 00259 } 00260 #endif 00261 00262 #endif /* !APR_DBM_H */