contrib/bind9/bin/named/include/named/zoneconf.h

   1 /*
   2  * Copyright (C) 2004-2007, 2010  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1999-2002  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: zoneconf.h,v 1.28 2010/12/20 23:47:20 tbox Exp $ */
  19
  20 #ifndef NS_ZONECONF_H
  21 #define NS_ZONECONF_H 1
  22
  23 /*! \file */
  24
  25 #include <isc/lang.h>
  26 #include <isc/types.h>
  27
  28 #include <isccfg/aclconf.h>
  29 #include <isccfg/cfg.h>
  30
  31 ISC_LANG_BEGINDECLS
  32
  33 isc_result_t
  34 ns_zone_configure(const cfg_obj_t *config, const cfg_obj_t *vconfig,
  35                   const cfg_obj_t *zconfig, cfg_aclconfctx_t *ac,
  36                   dns_zone_t *zone);
  37 /*%<
  38  * Configure or reconfigure a zone according to the named.conf
  39  * data in 'cctx' and 'czone'.
  40  *
  41  * The zone origin is not configured, it is assumed to have been set
  42  * at zone creation time.
  43  *
  44  * Require:
  45  * \li  'lctx' to be initialized or NULL.
  46  * \li  'cctx' to be initialized or NULL.
  47  * \li  'ac' to point to an initialized ns_aclconfctx_t.
  48  * \li  'czone' to be initialized.
  49  * \li  'zone' to be initialized.
  50  */
  51
  52 isc_boolean_t
  53 ns_zone_reusable(dns_zone_t *zone, const cfg_obj_t *zconfig);
  54 /*%<
  55  * If 'zone' can be safely reconfigured according to the configuration
  56  * data in 'zconfig', return ISC_TRUE.  If the configuration data is so
  57  * different from the current zone state that the zone needs to be destroyed
  58  * and recreated, return ISC_FALSE.
  59  */
  60
  61
  62 isc_result_t
  63 ns_zone_configure_writeable_dlz(dns_dlzdb_t *dlzdatabase, dns_zone_t *zone,
  64                                 dns_rdataclass_t rdclass, dns_name_t *name);
  65 /*%>
  66  * configure a DLZ zone, setting up the database methods and calling
  67  * postload to load the origin values
  68  *
  69  * Require:
  70  * \li  'dlzdatabase' to be a valid dlz database
  71  * \li  'zone' to be initialized.
  72  * \li  'rdclass' to be a valid rdataclass
  73  * \li  'name' to be a valid zone origin name
  74  */
  75
  76 ISC_LANG_ENDDECLS
  77
  78 #endif /* NS_ZONECONF_H */