/contrib/bind9/lib/dns/include/dns/private.h

 1/*
 2 * Copyright (C) 2009, 2012  Internet Systems Consortium, Inc. ("ISC")
 3 *
 4 * Permission to use, copy, modify, and/or distribute this software for any
 5 * purpose with or without fee is hereby granted, provided that the above
 6 * copyright notice and this permission notice appear in all copies.
 7 *
 8 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 9 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
10 * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
11 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
12 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
13 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
14 * PERFORMANCE OF THIS SOFTWARE.
15 */
16
17/* $Id$ */
18
19#include <isc/lang.h>
20#include <isc/types.h>
21
22#include <dns/types.h>
23#include <dns/db.h>
24
25#ifndef DNS_PRIVATE_H
26#define DNS_PRIVATE_H
27
28ISC_LANG_BEGINDECLS
29
30isc_result_t
31dns_private_chains(dns_db_t *db, dns_dbversion_t *ver,
32		   dns_rdatatype_t privatetype,
33		   isc_boolean_t *build_nsec, isc_boolean_t *build_nsec3);
34/*%<
35 * Examine the NSEC, NSEC3PARAM and privatetype RRsets at the apex of the
36 * database to determine which of NSEC or NSEC3 chains we are currently
37 * maintaining.  In normal operations only one of NSEC or NSEC3 is being
38 * maintained but when we are transitiong between NSEC and NSEC3 we need
39 * to update both sets of chains.  If 'privatetype' is zero then the
40 * privatetype RRset will not be examined.
41 *
42 * Requires:
43 * \li	'db' is valid.
44 * \li	'version' is valid or NULL.
45 * \li	'build_nsec' is a pointer to a isc_boolean_t or NULL.
46 * \li	'build_nsec3' is a pointer to a isc_boolean_t or NULL.
47 *
48 * Returns:
49 * \li 	ISC_R_SUCCESS, 'build_nsec' and 'build_nsec3' will be valid.
50 * \li	other on error
51 */
52
53ISC_LANG_ENDDECLS
54
55#endif