2 * Copyright (C) 2004, 2005, 2007 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 1999-2001 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: dbiterator.c,v 1.18 2007/06/19 23:47:16 tbox Exp $ */
26 #include <dns/dbiterator.h>
30 dns_dbiterator_destroy(dns_dbiterator_t **iteratorp) {
32 * Destroy '*iteratorp'.
35 REQUIRE(iteratorp != NULL);
36 REQUIRE(DNS_DBITERATOR_VALID(*iteratorp));
38 (*iteratorp)->methods->destroy(iteratorp);
40 ENSURE(*iteratorp == NULL);
44 dns_dbiterator_first(dns_dbiterator_t *iterator) {
46 * Move the node cursor to the first node in the database (if any).
49 REQUIRE(DNS_DBITERATOR_VALID(iterator));
51 return (iterator->methods->first(iterator));
55 dns_dbiterator_last(dns_dbiterator_t *iterator) {
57 * Move the node cursor to the first node in the database (if any).
60 REQUIRE(DNS_DBITERATOR_VALID(iterator));
62 return (iterator->methods->last(iterator));
66 dns_dbiterator_seek(dns_dbiterator_t *iterator, dns_name_t *name) {
68 * Move the node cursor to the node with name 'name'.
71 REQUIRE(DNS_DBITERATOR_VALID(iterator));
73 return (iterator->methods->seek(iterator, name));
77 dns_dbiterator_prev(dns_dbiterator_t *iterator) {
79 * Move the node cursor to the previous node in the database (if any).
82 REQUIRE(DNS_DBITERATOR_VALID(iterator));
84 return (iterator->methods->prev(iterator));
88 dns_dbiterator_next(dns_dbiterator_t *iterator) {
90 * Move the node cursor to the next node in the database (if any).
93 REQUIRE(DNS_DBITERATOR_VALID(iterator));
95 return (iterator->methods->next(iterator));
99 dns_dbiterator_current(dns_dbiterator_t *iterator, dns_dbnode_t **nodep,
103 * Return the current node.
106 REQUIRE(DNS_DBITERATOR_VALID(iterator));
107 REQUIRE(nodep != NULL && *nodep == NULL);
108 REQUIRE(name == NULL || dns_name_hasbuffer(name));
110 return (iterator->methods->current(iterator, nodep, name));
114 dns_dbiterator_pause(dns_dbiterator_t *iterator) {
119 REQUIRE(DNS_DBITERATOR_VALID(iterator));
121 return (iterator->methods->pause(iterator));
125 dns_dbiterator_origin(dns_dbiterator_t *iterator, dns_name_t *name) {
128 * Return the origin to which returned node names are relative.
131 REQUIRE(DNS_DBITERATOR_VALID(iterator));
132 REQUIRE(iterator->relative_names);
133 REQUIRE(dns_name_hasbuffer(name));
135 return (iterator->methods->origin(iterator, name));
139 dns_dbiterator_setcleanmode(dns_dbiterator_t *iterator, isc_boolean_t mode) {
140 REQUIRE(DNS_DBITERATOR_VALID(iterator));
142 iterator->cleaning = mode;