Gecko [ paxlifestyle.com ]

Name	Size	Permission	Date
acl.h	8.74 KB	-rw-r--r--	2025-01-20 13:39
adb.h	21.28 KB	-rw-r--r--	2025-01-20 13:39
badcache.h	3.28 KB	-rw-r--r--	2025-01-20 13:39
bit.h	788 B	-rw-r--r--	2025-01-20 13:39
byaddr.h	3.5 KB	-rw-r--r--	2025-01-20 13:39
cache.h	6.68 KB	-rw-r--r--	2025-01-20 13:39
callbacks.h	2.04 KB	-rw-r--r--	2025-01-20 13:39
catz.h	12.03 KB	-rw-r--r--	2025-01-20 13:39
cert.h	1.42 KB	-rw-r--r--	2025-01-20 13:39
client.h	9.18 KB	-rw-r--r--	2025-01-20 13:39
clientinfo.h	2.58 KB	-rw-r--r--	2025-01-20 13:39
compress.h	6.86 KB	-rw-r--r--	2025-01-20 13:39
db.h	49.1 KB	-rw-r--r--	2025-01-20 13:39
dbiterator.h	7.18 KB	-rw-r--r--	2025-01-20 13:39
diff.h	6.86 KB	-rw-r--r--	2025-01-20 13:39
dispatch.h	10.25 KB	-rw-r--r--	2026-03-27 00:00
dlz.h	10.61 KB	-rw-r--r--	2025-01-20 13:39
dlz_dlopen.h	4.27 KB	-rw-r--r--	2025-01-20 13:39
dns64.h	6.22 KB	-rw-r--r--	2025-01-20 13:39
dnsrps.h	2.49 KB	-rw-r--r--	2025-01-20 13:39
dnssec.h	12.86 KB	-rw-r--r--	2025-01-20 13:39
dnstap.h	9.95 KB	-rw-r--r--	2025-01-20 13:39
ds.h	1.62 KB	-rw-r--r--	2025-01-20 13:39
dsdigest.h	1.65 KB	-rw-r--r--	2025-01-20 13:39
dyndb.h	4.8 KB	-rw-r--r--	2025-01-20 13:39
ecs.h	1.91 KB	-rw-r--r--	2025-01-20 13:39
edns.h	763 B	-rw-r--r--	2025-01-20 13:39
enumclass.h	1.13 KB	-rw-r--r--	2026-03-27 00:00
enumtype.h	8.42 KB	-rw-r--r--	2026-03-27 00:00
events.h	4.33 KB	-rw-r--r--	2025-01-20 13:39
fixedname.h	1.59 KB	-rw-r--r--	2025-01-20 13:39
forward.h	3.13 KB	-rw-r--r--	2025-01-20 13:39
geoip.h	2.27 KB	-rw-r--r--	2025-01-20 13:39
ipkeylist.h	2.13 KB	-rw-r--r--	2025-01-20 13:39
iptable.h	1.46 KB	-rw-r--r--	2025-01-20 13:39
journal.h	9.46 KB	-rw-r--r--	2025-01-20 13:39
kasp.h	12.46 KB	-rw-r--r--	2025-01-20 13:39
keydata.h	1 KB	-rw-r--r--	2025-01-20 13:39
keyflags.h	1.22 KB	-rw-r--r--	2025-01-20 13:39
keymgr.h	3.99 KB	-rw-r--r--	2025-01-20 13:39
keytable.h	7.85 KB	-rw-r--r--	2025-01-20 13:39
keyvalues.h	3.96 KB	-rw-r--r--	2025-01-20 13:39
librpz.h	30.29 KB	-rw-r--r--	2025-01-20 13:39
log.h	3.91 KB	-rw-r--r--	2025-01-20 13:39
lookup.h	2.84 KB	-rw-r--r--	2025-01-20 13:39
master.h	8.52 KB	-rw-r--r--	2025-01-20 13:39
masterdump.h	9.64 KB	-rw-r--r--	2025-01-20 13:39
message.h	41.35 KB	-rw-r--r--	2026-03-27 00:00
name.h	36.35 KB	-rw-r--r--	2025-01-20 13:39
ncache.h	4.83 KB	-rw-r--r--	2025-01-20 13:39
nsec.h	3.43 KB	-rw-r--r--	2025-01-20 13:39
nsec3.h	8.05 KB	-rw-r--r--	2025-01-20 13:39
nta.h	4.6 KB	-rw-r--r--	2025-01-20 13:39
opcode.h	987 B	-rw-r--r--	2025-01-20 13:39
order.h	1.95 KB	-rw-r--r--	2025-01-20 13:39
peer.h	4.8 KB	-rw-r--r--	2025-01-20 13:39
private.h	1.89 KB	-rw-r--r--	2025-01-20 13:39
rbt.h	34.66 KB	-rw-r--r--	2025-01-20 13:39
rcode.h	2.4 KB	-rw-r--r--	2025-01-20 13:39
rdata.h	22.21 KB	-rw-r--r--	2025-01-20 13:39
rdataclass.h	2.17 KB	-rw-r--r--	2025-01-20 13:39
rdatalist.h	2.47 KB	-rw-r--r--	2025-01-20 13:39
rdataset.h	18.67 KB	-rw-r--r--	2025-01-20 13:39
rdatasetiter.h	3.81 KB	-rw-r--r--	2025-01-20 13:39
rdataslab.h	4.11 KB	-rw-r--r--	2025-01-20 13:39
rdatastruct.h	60.33 KB	-rw-r--r--	2026-03-27 00:00
rdatatype.h	2.21 KB	-rw-r--r--	2025-01-20 13:39
request.h	8.67 KB	-rw-r--r--	2026-03-27 00:00
resolver.h	18.7 KB	-rw-r--r--	2025-01-20 13:39
result.h	689 B	-rw-r--r--	2025-01-20 13:39
rootns.h	872 B	-rw-r--r--	2025-01-20 13:39
rpz.h	12.22 KB	-rw-r--r--	2025-01-20 13:39
rriterator.h	4.09 KB	-rw-r--r--	2025-01-20 13:39
rrl.h	6.8 KB	-rw-r--r--	2025-01-20 13:39
sdb.h	7.17 KB	-rw-r--r--	2025-01-20 13:39
sdlz.h	13.75 KB	-rw-r--r--	2025-01-20 13:39
secalg.h	1.65 KB	-rw-r--r--	2025-01-20 13:39
secproto.h	1.5 KB	-rw-r--r--	2025-01-20 13:39
soa.h	2.12 KB	-rw-r--r--	2025-01-20 13:39
ssu.h	7.6 KB	-rw-r--r--	2025-01-20 13:39
stats.h	24.15 KB	-rw-r--r--	2025-01-20 13:39
time.h	1.64 KB	-rw-r--r--	2025-01-20 13:39
tkey.h	7.46 KB	-rw-r--r--	2025-01-20 13:39
transport.h	5.93 KB	-rw-r--r--	2026-03-27 00:00
tsec.h	2.86 KB	-rw-r--r--	2025-01-20 13:39
tsig.h	8.18 KB	-rw-r--r--	2025-01-20 13:39
ttl.h	1.82 KB	-rw-r--r--	2025-01-20 13:39
types.h	14.03 KB	-rw-r--r--	2026-03-27 00:00
update.h	1.94 KB	-rw-r--r--	2025-01-20 13:39
validator.h	6.6 KB	-rw-r--r--	2025-01-20 13:39
view.h	36.94 KB	-rw-r--r--	2025-01-20 13:39
xfrin.h	2.26 KB	-rw-r--r--	2025-01-20 13:39
zone.h	63.88 KB	-rw-r--r--	2025-01-20 13:39
zonekey.h	754 B	-rw-r--r--	2025-01-20 13:39
zoneverify.h	1.4 KB	-rw-r--r--	2025-01-20 13:39
zt.h	5.02 KB	-rw-r--r--	2025-01-20 13:39

Rename

/*
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
 *
 * SPDX-License-Identifier: MPL-2.0
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, you can obtain one at https://mozilla.org/MPL/2.0/.
 *
 * See the COPYRIGHT file distributed with this work for additional
 * information regarding copyright ownership.
 */

#pragma once

/*****
***** Module Info
*****/

/*! \file dns/rdatasetiter.h
 * \brief
 * The DNS Rdataset Iterator interface allows iteration of all of the
 * rdatasets at a node.
 *
 * The dns_rdatasetiter_t type is like a "virtual class".  To actually use
 * it, an implementation of the class is required.  This implementation is
 * supplied by the database.
 *
 * It is the client's responsibility to call dns_rdataset_disassociate()
 * on all rdatasets returned.
 *
 * XXX more XXX
 *
 * MP:
 *\li	The iterator itself is not locked.  The caller must ensure
 *	synchronization.
 *
 *\li	The iterator methods ensure appropriate database locking.
 *
 * Reliability:
 *\li	No anticipated impact.
 *
 * Resources:
 *\li	TBS
 *
 * Security:
 *\li	No anticipated impact.
 *
 * Standards:
 *\li	None.
 */

/*****
***** Imports
*****/

#include <isc/lang.h>
#include <isc/magic.h>
#include <isc/stdtime.h>

#include <dns/types.h>

ISC_LANG_BEGINDECLS

/*****
***** Types
*****/

typedef struct dns_rdatasetitermethods {
	void (*destroy)(dns_rdatasetiter_t **iteratorp);
	isc_result_t (*first)(dns_rdatasetiter_t *iterator);
	isc_result_t (*next)(dns_rdatasetiter_t *iterator);
	void (*current)(dns_rdatasetiter_t *iterator, dns_rdataset_t *rdataset);
} dns_rdatasetitermethods_t;

#define DNS_RDATASETITER_MAGIC	  ISC_MAGIC('D', 'N', 'S', 'i')
#define DNS_RDATASETITER_VALID(i) ISC_MAGIC_VALID(i, DNS_RDATASETITER_MAGIC)

/*%
 * This structure is actually just the common prefix of a DNS db
 * implementation's version of a dns_rdatasetiter_t.
 * \brief
 * Direct use of this structure by clients is forbidden.  DB implementations
 * may change the structure.  'magic' must be #DNS_RDATASETITER_MAGIC for
 * any of the dns_rdatasetiter routines to work.  DB implementations must
 * maintain all DB rdataset iterator invariants.
 */
struct dns_rdatasetiter {
	/* Unlocked. */
	unsigned int		   magic;
	dns_rdatasetitermethods_t *methods;
	dns_db_t		  *db;
	dns_dbnode_t		  *node;
	dns_dbversion_t		  *version;
	isc_stdtime_t		   now;
	unsigned int		   options;
};

void
dns_rdatasetiter_destroy(dns_rdatasetiter_t **iteratorp);
/*%<
 * Destroy '*iteratorp'.
 *
 * Requires:
 *
 *\li	'*iteratorp' is a valid iterator.
 *
 * Ensures:
 *
 *\li	All resources used by the iterator are freed.
 *
 *\li	*iteratorp == NULL.
 */

isc_result_t
dns_rdatasetiter_first(dns_rdatasetiter_t *iterator);
/*%<
 * Move the rdataset cursor to the first rdataset at the node (if any).
 *
 * Requires:
 *\li	'iterator' is a valid iterator.
 *
 * Returns:
 *\li	ISC_R_SUCCESS
 *\li	ISC_R_NOMORE			There are no rdatasets at the node.
 *
 *\li	Other results are possible, depending on the DB implementation.
 */

isc_result_t
dns_rdatasetiter_next(dns_rdatasetiter_t *iterator);
/*%<
 * Move the rdataset cursor to the next rdataset at the node (if any).
 *
 * Requires:
 *\li	'iterator' is a valid iterator.
 *
 * Returns:
 *\li	ISC_R_SUCCESS
 *\li	ISC_R_NOMORE			There are no more rdatasets at the
 *					node.
 *
 *\li	Other results are possible, depending on the DB implementation.
 */

void
dns_rdatasetiter_current(dns_rdatasetiter_t *iterator,
			 dns_rdataset_t	    *rdataset);
/*%<
 * Return the current rdataset.
 *
 * Requires:
 *\li	'iterator' is a valid iterator.
 *
 *\li	'rdataset' is a valid, disassociated rdataset.
 *
 *\li	The rdataset cursor of 'iterator' is at a valid location (i.e. the
 *	result of last call to a cursor movement command was #ISC_R_SUCCESS).
 */

ISC_LANG_ENDDECLS