2 * Copyright (C) 2004-2007 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2002 Internet Software Consortium.
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.
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.
18 /* $Id: zt.h,v 1.38 2007/06/19 23:47:17 tbox Exp $ */
27 #include <dns/types.h>
29 #define DNS_ZTFIND_NOEXACT 0x01
34 dns_zt_create(isc_mem_t *mctx, dns_rdataclass_t rdclass, dns_zt_t **zt);
36 * Creates a new zone table.
39 * \li 'mctx' to be initialized.
42 * \li #ISC_R_SUCCESS on success.
47 dns_zt_mount(dns_zt_t *zt, dns_zone_t *zone);
49 * Mounts the zone on the zone table.
52 * \li 'zt' to be valid
53 * \li 'zone' to be valid
63 dns_zt_unmount(dns_zt_t *zt, dns_zone_t *zone);
65 * Unmount the given zone from the table.
69 * \li 'zone' to be valid
78 dns_zt_find(dns_zt_t *zt, dns_name_t *name, unsigned int options,
79 dns_name_t *foundname, dns_zone_t **zone);
81 * Find the best match for 'name' in 'zt'. If foundname is non NULL
82 * then the name of the zone found is returned.
85 * \li If the DNS_ZTFIND_NOEXACT is set, the best partial match (if any)
86 * to 'name' will be returned.
89 * \li 'zt' to be valid
90 * \li 'name' to be valid
91 * \li 'foundname' to be initialized and associated with a fixedname or NULL
92 * \li 'zone' to be non NULL and '*zone' to be NULL
96 * \li #DNS_R_PARTIALMATCH
102 dns_zt_detach(dns_zt_t **ztp);
104 * Detach the given zonetable, if the reference count goes to zero the
105 * zonetable will be freed. In either case 'ztp' is set to NULL.
108 * \li '*ztp' to be valid
112 dns_zt_flushanddetach(dns_zt_t **ztp);
114 * Detach the given zonetable, if the reference count goes to zero the
115 * zonetable will be flushed and then freed. In either case 'ztp' is
119 * \li '*ztp' to be valid
123 dns_zt_attach(dns_zt_t *zt, dns_zt_t **ztp);
125 * Attach 'zt' to '*ztp'.
128 * \li 'zt' to be valid
129 * \li '*ztp' to be NULL
133 dns_zt_load(dns_zt_t *zt, isc_boolean_t stop);
136 dns_zt_loadnew(dns_zt_t *zt, isc_boolean_t stop);
138 * Load all zones in the table. If 'stop' is ISC_TRUE,
139 * stop on the first error and return it. If 'stop'
140 * is ISC_FALSE, ignore errors.
142 * dns_zt_loadnew() only loads zones that are not yet loaded.
143 * dns_zt_load() also loads zones that are already loaded and
144 * and whose master file has changed since the last load.
147 * \li 'zt' to be valid
151 dns_zt_freezezones(dns_zt_t *zt, isc_boolean_t freeze);
153 * Freeze/thaw updates to master zones.
154 * Any pending updates will be flushed.
155 * Zones will be reloaded on thaw.
159 dns_zt_apply(dns_zt_t *zt, isc_boolean_t stop,
160 isc_result_t (*action)(dns_zone_t *, void *), void *uap);
163 dns_zt_apply2(dns_zt_t *zt, isc_boolean_t stop, isc_result_t *sub,
164 isc_result_t (*action)(dns_zone_t *, void *), void *uap);
166 * Apply a given 'action' to all zone zones in the table.
167 * If 'stop' is 'ISC_TRUE' then walking the zone tree will stop if
168 * 'action' does not return ISC_R_SUCCESS.
171 * \li 'zt' to be valid.
172 * \li 'action' to be non NULL.
175 * \li ISC_R_SUCCESS if action was applied to all nodes. If 'stop' is
176 * ISC_FALSE and 'sub' is non NULL then the first error (if any)
177 * reported by 'action' is returned in '*sub';
178 * any error code from 'action'.
183 #endif /* DNS_ZT_H */