/* * Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") * Copyright (C) 1999-2002 Internet Software Consortium. * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR * PERFORMANCE OF THIS SOFTWARE. */ /* $Id: zt.h,v 1.27.2.2.8.1 2004/03/06 08:14:01 marka Exp $ */ #ifndef DNS_ZT_H #define DNS_ZT_H 1 #include #include #define DNS_ZTFIND_NOEXACT 0x01 ISC_LANG_BEGINDECLS isc_result_t dns_zt_create(isc_mem_t *mctx, dns_rdataclass_t rdclass, dns_zt_t **zt); /* * Creates a new zone table. * * Requires: * 'mctx' to be initialized. * * Returns: * ISC_R_SUCCESS on success. * ISC_R_NOMEMORY */ isc_result_t dns_zt_mount(dns_zt_t *zt, dns_zone_t *zone); /* * Mounts the zone on the zone table. * * Requires: * 'zt' to be valid * 'zone' to be valid * * Returns: * ISC_R_SUCCESS * ISC_R_EXISTS * ISC_R_NOSPACE * ISC_R_NOMEMORY */ isc_result_t dns_zt_unmount(dns_zt_t *zt, dns_zone_t *zone); /* * Unmount the given zone from the table. * * Requires: * 'zt' to be valid * 'zone' to be valid * * Returns: * ISC_R_SUCCESS * ISC_R_NOTFOUND * ISC_R_NOMEMORY */ isc_result_t dns_zt_find(dns_zt_t *zt, dns_name_t *name, unsigned int options, dns_name_t *foundname, dns_zone_t **zone); /* * Find the best match for 'name' in 'zt'. If foundname is non NULL * then the name of the zone found is returned. * * Notes: * If the DNS_ZTFIND_NOEXACT is set, the best partial match (if any) * to 'name' will be returned. * * Requires: * 'zt' to be valid * 'name' to be valid * 'foundname' to be initialized and associated with a fixedname or NULL * 'zone' to be non NULL and '*zone' to be NULL * * Returns: * ISC_R_SUCCESS * DNS_R_PARTIALMATCH * ISC_R_NOTFOUND * ISC_R_NOSPACE */ void dns_zt_detach(dns_zt_t **ztp); /* * Detach the given zonetable, if the reference count goes to zero the * zonetable will be freed. In either case 'ztp' is set to NULL. * * Requires: * '*ztp' to be valid */ void dns_zt_flushanddetach(dns_zt_t **ztp); /* * Detach the given zonetable, if the reference count goes to zero the * zonetable will be flushed and then freed. In either case 'ztp' is * set to NULL. * * Requires: * '*ztp' to be valid */ void dns_zt_attach(dns_zt_t *zt, dns_zt_t **ztp); /* * Attach 'zt' to '*ztp'. * * Requires: * 'zt' to be valid * '*ztp' to be NULL */ isc_result_t dns_zt_load(dns_zt_t *zt, isc_boolean_t stop); isc_result_t dns_zt_loadnew(dns_zt_t *zt, isc_boolean_t stop); /* * Load all zones in the table. If 'stop' is ISC_TRUE, * stop on the first error and return it. If 'stop' * is ISC_FALSE, ignore errors. * * dns_zt_loadnew() only loads zones that are not yet loaded. * dns_zt_load() also loads zones that are already loaded and * and whose master file has changed since the last load. * * Requires: * 'zt' to be valid */ isc_result_t dns_zt_apply(dns_zt_t *zt, isc_boolean_t stop, isc_result_t (*action)(dns_zone_t *, void *), void *uap); /* * Apply a given 'action' to all zone zones in the table. * If 'stop' is 'ISC_TRUE' then walking the zone tree will stop if * 'action' does not return ISC_R_SUCCESS. * * Requires: * 'zt' to be valid. * 'action' to be non NULL. * * Returns: * ISC_R_SUCCESS if action was applied to all nodes. * any error code from 'action'. */ ISC_LANG_ENDDECLS #endif /* DNS_ZT_H */
