1 /* $NetBSD: dbiterator.c,v 1.4 2014/12/10 04:37:58 christos Exp $ */ 2 3 /* 4 * Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC") 5 * Copyright (C) 1999-2001 Internet Software Consortium. 6 * 7 * Permission to use, copy, modify, and/or distribute this software for any 8 * purpose with or without fee is hereby granted, provided that the above 9 * copyright notice and this permission notice appear in all copies. 10 * 11 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH 12 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 13 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, 14 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM 15 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE 16 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 17 * PERFORMANCE OF THIS SOFTWARE. 18 */ 19 20 /* Id: dbiterator.c,v 1.18 2007/06/19 23:47:16 tbox Exp */ 21 22 /*! \file */ 23 24 #include <config.h> 25 26 #include <isc/util.h> 27 28 #include <dns/dbiterator.h> 29 #include <dns/name.h> 30 31 void 32 dns_dbiterator_destroy(dns_dbiterator_t **iteratorp) { 33 /* 34 * Destroy '*iteratorp'. 35 */ 36 37 REQUIRE(iteratorp != NULL); 38 REQUIRE(DNS_DBITERATOR_VALID(*iteratorp)); 39 40 (*iteratorp)->methods->destroy(iteratorp); 41 42 ENSURE(*iteratorp == NULL); 43 } 44 45 isc_result_t 46 dns_dbiterator_first(dns_dbiterator_t *iterator) { 47 /* 48 * Move the node cursor to the first node in the database (if any). 49 */ 50 51 REQUIRE(DNS_DBITERATOR_VALID(iterator)); 52 53 return (iterator->methods->first(iterator)); 54 } 55 56 isc_result_t 57 dns_dbiterator_last(dns_dbiterator_t *iterator) { 58 /* 59 * Move the node cursor to the first node in the database (if any). 60 */ 61 62 REQUIRE(DNS_DBITERATOR_VALID(iterator)); 63 64 return (iterator->methods->last(iterator)); 65 } 66 67 isc_result_t 68 dns_dbiterator_seek(dns_dbiterator_t *iterator, dns_name_t *name) { 69 /* 70 * Move the node cursor to the node with name 'name'. 71 */ 72 73 REQUIRE(DNS_DBITERATOR_VALID(iterator)); 74 75 return (iterator->methods->seek(iterator, name)); 76 } 77 78 isc_result_t 79 dns_dbiterator_prev(dns_dbiterator_t *iterator) { 80 /* 81 * Move the node cursor to the previous node in the database (if any). 82 */ 83 84 REQUIRE(DNS_DBITERATOR_VALID(iterator)); 85 86 return (iterator->methods->prev(iterator)); 87 } 88 89 isc_result_t 90 dns_dbiterator_next(dns_dbiterator_t *iterator) { 91 /* 92 * Move the node cursor to the next node in the database (if any). 93 */ 94 95 REQUIRE(DNS_DBITERATOR_VALID(iterator)); 96 97 return (iterator->methods->next(iterator)); 98 } 99 100 isc_result_t 101 dns_dbiterator_current(dns_dbiterator_t *iterator, dns_dbnode_t **nodep, 102 dns_name_t *name) 103 { 104 /* 105 * Return the current node. 106 */ 107 108 REQUIRE(DNS_DBITERATOR_VALID(iterator)); 109 REQUIRE(nodep != NULL && *nodep == NULL); 110 REQUIRE(name == NULL || dns_name_hasbuffer(name)); 111 112 return (iterator->methods->current(iterator, nodep, name)); 113 } 114 115 isc_result_t 116 dns_dbiterator_pause(dns_dbiterator_t *iterator) { 117 /* 118 * Pause iteration. 119 */ 120 121 REQUIRE(DNS_DBITERATOR_VALID(iterator)); 122 123 return (iterator->methods->pause(iterator)); 124 } 125 126 isc_result_t 127 dns_dbiterator_origin(dns_dbiterator_t *iterator, dns_name_t *name) { 128 129 /* 130 * Return the origin to which returned node names are relative. 131 */ 132 133 REQUIRE(DNS_DBITERATOR_VALID(iterator)); 134 REQUIRE(iterator->relative_names); 135 REQUIRE(dns_name_hasbuffer(name)); 136 137 return (iterator->methods->origin(iterator, name)); 138 } 139 140 void 141 dns_dbiterator_setcleanmode(dns_dbiterator_t *iterator, isc_boolean_t mode) { 142 REQUIRE(DNS_DBITERATOR_VALID(iterator)); 143 144 iterator->cleaning = mode; 145 } 146