contrib/bind9/lib/dns/include/dns/rriterator.h

   1 /*
   2  * Copyright (C) 2009  Internet Systems Consortium, Inc. ("ISC")
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
   9  * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  10  * AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
  11  * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
  12  * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
  13  * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  14  * PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 /* $Id: rriterator.h,v 1.2 2009-06-30 02:52:32 each Exp $ */
  18
  19 #ifndef DNS_RRITERATOR_H
  20 #define DNS_RRITERATOR_H 1
  21
  22 /*****
  23  ***** Module Info
  24  *****/
  25
  26 /*! \file dns/rriterator.h
  27  * \brief
  28  * Functions for "walking" a zone database, visiting each RR or RRset in turn.
  29  */
  30
  31 /*****
  32  ***** Imports
  33  *****/
  34
  35 #include <isc/lang.h>
  36 #include <isc/magic.h>
  37 #include <isc/ondestroy.h>
  38 #include <isc/stdtime.h>
  39
  40 #include <dns/db.h>
  41 #include <dns/dbiterator.h>
  42 #include <dns/fixedname.h>
  43 #include <dns/name.h>
  44 #include <dns/rdata.h>
  45 #include <dns/rdataset.h>
  46 #include <dns/rdatasetiter.h>
  47 #include <dns/types.h>
  48
  49 ISC_LANG_BEGINDECLS
  50
  51 /*****
  52  ***** Types
  53  *****/
  54
  55 /*%
  56  * A dns_rriterator_t is an iterator that iterates over an entire database,
  57  * returning one RR at a time, in some arbitrary order.
  58  */
  59
  60 typedef struct dns_rriterator {
  61         unsigned int            magic;
  62         isc_result_t            result;
  63         dns_db_t                *db;
  64         dns_dbiterator_t        *dbit;
  65         dns_dbversion_t         *ver;
  66         isc_stdtime_t           now;
  67         dns_dbnode_t            *node;
  68         dns_fixedname_t         fixedname;
  69         dns_rdatasetiter_t      *rdatasetit;
  70         dns_rdataset_t          rdataset;
  71         dns_rdata_t             rdata;
  72 } dns_rriterator_t;
  73
  74 #define RRITERATOR_MAGIC                ISC_MAGIC('R', 'R', 'I', 't')
  75 #define VALID_RRITERATOR(m)             ISC_MAGIC_VALID(m, RRITERATOR_MAGIC)
  76
  77 isc_result_t
  78 dns_rriterator_init(dns_rriterator_t *it, dns_db_t *db,
  79                        dns_dbversion_t *ver, isc_stdtime_t now);
  80
  81 isc_result_t
  82 dns_rriterator_first(dns_rriterator_t *it);
  83
  84 isc_result_t
  85 dns_rriterator_nextrrset(dns_rriterator_t *it);
  86
  87 isc_result_t
  88 dns_rriterator_next(dns_rriterator_t *it);
  89
  90 void
  91 dns_rriterator_current(dns_rriterator_t *it, dns_name_t **name,
  92                           isc_uint32_t *ttl, dns_rdataset_t **rdataset,
  93                           dns_rdata_t **rdata);
  94
  95 void
  96 dns_rriterator_pause(dns_rriterator_t *it);
  97
  98 void
  99 dns_rriterator_destroy(dns_rriterator_t *it);
 100
 101 ISC_LANG_ENDDECLS
 102
 103 #endif /* DNS_RRITERATOR_H */