rbtdb.h

Go to the documentation of this file.
00001 /*
00002  * Copyright (C) 2004, 2005, 2007, 2011, 2012  Internet Systems Consortium, Inc. ("ISC")
00003  * Copyright (C) 1999-2001  Internet Software Consortium.
00004  *
00005  * Permission to use, copy, modify, and/or distribute this software for any
00006  * purpose with or without fee is hereby granted, provided that the above
00007  * copyright notice and this permission notice appear in all copies.
00008  *
00009  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
00010  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
00011  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
00012  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
00013  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
00014  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
00015  * PERFORMANCE OF THIS SOFTWARE.
00016  */
00017 
00018 /* $Id$ */
00019 
00020 #ifndef DNS_RBTDB_H
00021 #define DNS_RBTDB_H 1
00022 
00023 #include <isc/lang.h>
00024 #include <dns/types.h>
00025 
00026 /*****
00027  ***** Module Info
00028  *****/
00029 
00030 /*! \file
00031  * \brief
00032  * DNS Red-Black Tree DB Implementation
00033  */
00034 
00035 ISC_LANG_BEGINDECLS
00036 
00037 isc_result_t
00038 dns_rbtdb_create(isc_mem_t *mctx, dns_name_t *base, dns_dbtype_t type,
00039                  dns_rdataclass_t rdclass, unsigned int argc, char *argv[],
00040                  void *driverarg, dns_db_t **dbp);
00041 
00042 /*%<
00043  * Create a new database of type "rbt" (or "rbt64").  Called via
00044  * dns_db_create(); see documentation for that function for more details.
00045  *
00046  * If argv[0] is set, it points to a valid memory context to be used for
00047  * allocation of heap memory.  Generally this is used for cache databases
00048  * only.
00049  *
00050  * Requires:
00051  *
00052  * \li argc == 0 or argv[0] is a valid memory context.
00053  */
00054 
00055 ISC_LANG_ENDDECLS
00056 
00057 #endif /* DNS_RBTDB_H */

Generated on Tue Apr 28 17:40:59 2015 by Doxygen 1.5.4 for BIND9 Internals 9.11.0pre-alpha