contrib/bind9/lib/dns/rbtdb.h

   1 /*
   2  * Copyright (C) 2004, 2005, 2007, 2011, 2012  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1999-2001  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and/or distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
  10  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  11  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  12  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  13  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  14  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  15  * PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /* $Id$ */
  19
  20 #ifndef DNS_RBTDB_H
  21 #define DNS_RBTDB_H 1
  22
  23 #include <isc/lang.h>
  24 #include <dns/types.h>
  25
  26 /*****
  27  ***** Module Info
  28  *****/
  29
  30 /*! \file
  31  * \brief
  32  * DNS Red-Black Tree DB Implementation
  33  */
  34
  35 ISC_LANG_BEGINDECLS
  36
  37 isc_result_t
  38 dns_rbtdb_create(isc_mem_t *mctx, dns_name_t *base, dns_dbtype_t type,
  39                  dns_rdataclass_t rdclass, unsigned int argc, char *argv[],
  40                  void *driverarg, dns_db_t **dbp);
  41
  42 /*%<
  43  * Create a new database of type "rbt" (or "rbt64").  Called via
  44  * dns_db_create(); see documentation for that function for more details.
  45  *
  46  * If argv[0] is set, it points to a valid memory context to be used for
  47  * allocation of heap memory.  Generally this is used for cache databases
  48  * only.
  49  *
  50  * Requires:
  51  *
  52  * \li argc == 0 or argv[0] is a valid memory context.
  53  */
  54
  55 ISC_LANG_ENDDECLS
  56
  57 #endif /* DNS_RBTDB_H */