contrib/bind-9.3/lib/dns/dbiterator.c

   1 /*
   2  * Copyright (C) 2004  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1999-2001  Internet Software Consortium.
   4  *
   5  * Permission to use, copy, modify, and 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.
   8  *
   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.
  16  */
  17
  18 /* $Id: dbiterator.c,v 1.13.206.1 2004/03/06 08:13:37 marka Exp $ */
  19
  20 #include <config.h>
  21
  22 #include <isc/util.h>
  23
  24 #include <dns/dbiterator.h>
  25 #include <dns/name.h>
  26
  27 void
  28 dns_dbiterator_destroy(dns_dbiterator_t **iteratorp) {
  29         /*
  30          * Destroy '*iteratorp'.
  31          */
  32
  33         REQUIRE(iteratorp != NULL);
  34         REQUIRE(DNS_DBITERATOR_VALID(*iteratorp));
  35
  36         (*iteratorp)->methods->destroy(iteratorp);
  37
  38         ENSURE(*iteratorp == NULL);
  39 }
  40
  41 isc_result_t
  42 dns_dbiterator_first(dns_dbiterator_t *iterator) {
  43         /*
  44          * Move the node cursor to the first node in the database (if any).
  45          */
  46
  47         REQUIRE(DNS_DBITERATOR_VALID(iterator));
  48
  49         return (iterator->methods->first(iterator));
  50 }
  51
  52 isc_result_t
  53 dns_dbiterator_last(dns_dbiterator_t *iterator) {
  54         /*
  55          * Move the node cursor to the first node in the database (if any).
  56          */
  57
  58         REQUIRE(DNS_DBITERATOR_VALID(iterator));
  59
  60         return (iterator->methods->last(iterator));
  61 }
  62
  63 isc_result_t
  64 dns_dbiterator_seek(dns_dbiterator_t *iterator, dns_name_t *name) {
  65         /*
  66          * Move the node cursor to the node with name 'name'.
  67          */
  68
  69         REQUIRE(DNS_DBITERATOR_VALID(iterator));
  70
  71         return (iterator->methods->seek(iterator, name));
  72 }
  73
  74 isc_result_t
  75 dns_dbiterator_prev(dns_dbiterator_t *iterator) {
  76         /*
  77          * Move the node cursor to the previous node in the database (if any).
  78          */
  79
  80         REQUIRE(DNS_DBITERATOR_VALID(iterator));
  81
  82         return (iterator->methods->prev(iterator));
  83 }
  84
  85 isc_result_t
  86 dns_dbiterator_next(dns_dbiterator_t *iterator) {
  87         /*
  88          * Move the node cursor to the next node in the database (if any).
  89          */
  90
  91         REQUIRE(DNS_DBITERATOR_VALID(iterator));
  92
  93         return (iterator->methods->next(iterator));
  94 }
  95
  96 isc_result_t
  97 dns_dbiterator_current(dns_dbiterator_t *iterator, dns_dbnode_t **nodep,
  98                        dns_name_t *name)
  99 {
 100         /*
 101          * Return the current node.
 102          */
 103
 104         REQUIRE(DNS_DBITERATOR_VALID(iterator));
 105         REQUIRE(nodep != NULL && *nodep == NULL);
 106         REQUIRE(name == NULL || dns_name_hasbuffer(name));
 107
 108         return (iterator->methods->current(iterator, nodep, name));
 109 }
 110
 111 isc_result_t
 112 dns_dbiterator_pause(dns_dbiterator_t *iterator) {
 113         /*
 114          * Pause iteration.
 115          */
 116
 117         REQUIRE(DNS_DBITERATOR_VALID(iterator));
 118
 119         return (iterator->methods->pause(iterator));
 120 }
 121
 122 isc_result_t
 123 dns_dbiterator_origin(dns_dbiterator_t *iterator, dns_name_t *name) {
 124
 125         /*
 126          * Return the origin to which returned node names are relative.
 127          */
 128
 129         REQUIRE(DNS_DBITERATOR_VALID(iterator));
 130         REQUIRE(iterator->relative_names);
 131         REQUIRE(dns_name_hasbuffer(name));
 132
 133         return (iterator->methods->origin(iterator, name));
 134 }
 135
 136 void
 137 dns_dbiterator_setcleanmode(dns_dbiterator_t *iterator, isc_boolean_t mode) {
 138         REQUIRE(DNS_DBITERATOR_VALID(iterator));
 139
 140         iterator->cleaning = mode;
 141 }