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

apr_sdbm.h

Go to the documentation of this file.
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 /*
00056  * sdbm - ndbm work-alike hashed database library
00057  * based on Per-Ake Larson's Dynamic Hashing algorithms. BIT 18 (1978).
00058  * author: oz@nexus.yorku.ca
00059  * status: ex-public domain
00060  */
00061 
00062 #ifndef APR_SDBM_H
00063 #define APR_SDBM_H
00064 
00065 #include "apu.h"
00066 #include "apr_errno.h"
00067 #include "apr_file_io.h"   /* for apr_fileperms_t */
00068 
00082 typedef struct apr_sdbm_t apr_sdbm_t;
00083 
00087 typedef struct {
00089     char *dptr;
00091     int dsize;
00092 } apr_sdbm_datum_t;
00093 
00094 /* The extensions used for the database files */
00096 #define APR_SDBM_DIRFEXT        ".dir"
00097 
00098 #define APR_SDBM_PAGFEXT        ".pag"
00099 
00100 /* flags to sdbm_store */
00101 #define APR_SDBM_INSERT     0   
00102 #define APR_SDBM_REPLACE    1   
00103 #define APR_SDBM_INSERTDUP  2   
00123 APU_DECLARE(apr_status_t) apr_sdbm_open(apr_sdbm_t **db, const char *name, 
00124                                         apr_int32_t mode, 
00125                                         apr_fileperms_t perms, apr_pool_t *p);
00126 
00131 APU_DECLARE(apr_status_t) apr_sdbm_close(apr_sdbm_t *db);
00132 
00148 APU_DECLARE(apr_status_t) apr_sdbm_lock(apr_sdbm_t *db, int type);
00149 
00154 APU_DECLARE(apr_status_t) apr_sdbm_unlock(apr_sdbm_t *db);
00155 
00162 APU_DECLARE(apr_status_t) apr_sdbm_fetch(apr_sdbm_t *db, 
00163                                          apr_sdbm_datum_t *value, 
00164                                          apr_sdbm_datum_t key);
00165 
00177 APU_DECLARE(apr_status_t) apr_sdbm_store(apr_sdbm_t *db, apr_sdbm_datum_t key,
00178                                          apr_sdbm_datum_t value, int opt);
00179 
00186 APU_DECLARE(apr_status_t) apr_sdbm_delete(apr_sdbm_t *db, 
00187                                           const apr_sdbm_datum_t key);
00188 
00198 APU_DECLARE(apr_status_t) apr_sdbm_firstkey(apr_sdbm_t *db, apr_sdbm_datum_t *key);
00199 
00205 APU_DECLARE(apr_status_t) apr_sdbm_nextkey(apr_sdbm_t *db, apr_sdbm_datum_t *key);
00206 
00211 APU_DECLARE(int) apr_sdbm_rdonly(apr_sdbm_t *db);
00213 #endif /* APR_SDBM_H */

Generated on Tue Dec 7 18:34:56 2010 for Apache Portable Runtime Utility Library by  doxygen 1.3.9.1