Main Page | Modules | Namespace List | Data Structures | File List | Data Fields | Globals | Related Pages

apr_dbm_private.h

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_PRIVATE_H
00056 #define APR_DBM_PRIVATE_H
00057 
00058 #include "apr.h"
00059 #include "apr_errno.h"
00060 #include "apr_pools.h"
00061 #include "apr_dbm.h"
00062 #include "apr_file_io.h"
00063 
00064 #include "apu.h"
00065 
00066 /* ### for now, include the DBM selection; this will go away once we start
00067    ### building and linking all of the DBMs at once. */
00068 #include "apu_select_dbm.h"
00069 
00070 #ifdef __cplusplus
00071 extern "C" {
00072 #endif
00073 
00080 APU_DECLARE(int) apr_posix_perms2mode(apr_fileperms_t perm);
00081 
00085 typedef struct {
00087     const char *name;
00088 
00090     apr_status_t (*open)(apr_dbm_t **pdb, const char *pathname,
00091                          apr_int32_t mode, apr_fileperms_t perm,
00092                          apr_pool_t *pool);
00093 
00095     void (*close)(apr_dbm_t *dbm);
00096 
00098     apr_status_t (*fetch)(apr_dbm_t *dbm, apr_datum_t key,
00099                                    apr_datum_t * pvalue);
00100 
00102     apr_status_t (*store)(apr_dbm_t *dbm, apr_datum_t key, apr_datum_t value);
00103 
00105     apr_status_t (*del)(apr_dbm_t *dbm, apr_datum_t key);
00106 
00108     int (*exists)(apr_dbm_t *dbm, apr_datum_t key);
00109 
00111     apr_status_t (*firstkey)(apr_dbm_t *dbm, apr_datum_t * pkey);
00112 
00114     apr_status_t (*nextkey)(apr_dbm_t *dbm, apr_datum_t * pkey);
00115 
00117     void (*freedatum)(apr_dbm_t *dbm, apr_datum_t data);
00118 
00120     void (*getusednames)(apr_pool_t *pool,
00121                          const char *pathname,
00122                          const char **used1,
00123                          const char **used2);
00124 
00125 } apr_dbm_type_t;
00126 
00127 
00131 struct apr_dbm_t
00132 { 
00134     apr_pool_t *pool;
00135 
00137     void *file;
00138 
00140     int errcode;
00142     const char *errmsg;
00143 
00145     const apr_dbm_type_t *type;
00146 };
00147 
00148 
00149 /* Declare all of the builtin DBM providers */
00150 APU_DECLARE_DATA extern const apr_dbm_type_t apr_dbm_type_sdbm;
00151 APU_DECLARE_DATA extern const apr_dbm_type_t apr_dbm_type_gdbm;
00152 APU_DECLARE_DATA extern const apr_dbm_type_t apr_dbm_type_ndbm;
00153 APU_DECLARE_DATA extern const apr_dbm_type_t apr_dbm_type_db1;
00154 APU_DECLARE_DATA extern const apr_dbm_type_t apr_dbm_type_db2;
00155 APU_DECLARE_DATA extern const apr_dbm_type_t apr_dbm_type_db3;
00156 APU_DECLARE_DATA extern const apr_dbm_type_t apr_dbm_type_db4;
00157 APU_DECLARE_DATA extern const apr_dbm_type_t apr_dbm_type_db;
00158 
00159 #ifdef __cplusplus
00160 }
00161 #endif
00162 
00163 #endif /* APR_DBM_PRIVATE_H */

Generated on Wed Dec 8 00:35:23 2010 for Apache Portable Runtime Utility Library by  doxygen 1.3.9.1