Gecko [ armaneco.co.uk ]

Name	Size	Permission	Date
acache.h	13.99 KB	-rw-r--r--	2025-03-04 13:53
acl.h	7.1 KB	-rw-r--r--	2025-03-04 13:53
adb.h	22.03 KB	-rw-r--r--	2025-03-04 13:53
badcache.h	3.28 KB	-rw-r--r--	2025-03-04 13:53
bit.h	856 B	-rw-r--r--	2025-03-04 13:53
byaddr.h	3.89 KB	-rw-r--r--	2025-03-04 13:53
cache.h	7.95 KB	-rw-r--r--	2025-03-04 13:53
callbacks.h	2.22 KB	-rw-r--r--	2025-03-04 13:53
catz.h	11.54 KB	-rw-r--r--	2025-03-04 13:53
cert.h	1.43 KB	-rw-r--r--	2025-03-04 13:53
client.h	21.52 KB	-rw-r--r--	2025-03-04 13:53
clientinfo.h	1.95 KB	-rw-r--r--	2025-03-04 13:53
compress.h	6.51 KB	-rw-r--r--	2025-03-04 13:53
db.h	44.68 KB	-rw-r--r--	2025-03-04 13:53
dbiterator.h	7.26 KB	-rw-r--r--	2025-03-04 13:53
dbtable.h	3.09 KB	-rw-r--r--	2025-03-04 13:53
diff.h	6.82 KB	-rw-r--r--	2025-03-04 13:53
dispatch.h	16.05 KB	-rw-r--r--	2025-03-04 13:53
dlz.h	10.38 KB	-rw-r--r--	2025-03-04 13:53
dlz_dlopen.h	4.54 KB	-rw-r--r--	2025-03-04 13:53
dns64.h	5.51 KB	-rw-r--r--	2025-03-04 13:53
dnssec.h	12 KB	-rw-r--r--	2025-03-04 13:53
dnstap.h	9.2 KB	-rw-r--r--	2025-03-04 13:53
ds.h	1.19 KB	-rw-r--r--	2025-03-04 13:53
dsdigest.h	1.68 KB	-rw-r--r--	2025-03-04 13:53
dyndb.h	4.72 KB	-rw-r--r--	2025-03-04 13:53
ecdb.h	808 B	-rw-r--r--	2025-03-04 13:53
edns.h	721 B	-rw-r--r--	2025-03-04 13:53
enumclass.h	1.19 KB	-rw-r--r--	2025-03-04 13:53
enumtype.h	7.74 KB	-rw-r--r--	2025-03-04 13:53
events.h	3.96 KB	-rw-r--r--	2025-03-04 13:53
fixedname.h	1.56 KB	-rw-r--r--	2025-03-04 13:53
forward.h	3.37 KB	-rw-r--r--	2025-03-04 13:53
geoip.h	2.34 KB	-rw-r--r--	2025-03-04 13:53
ipkeylist.h	2.12 KB	-rw-r--r--	2025-03-04 13:53
iptable.h	1.6 KB	-rw-r--r--	2025-03-04 13:53
journal.h	8.05 KB	-rw-r--r--	2025-03-04 13:53
keydata.h	1.02 KB	-rw-r--r--	2025-03-04 13:53
keyflags.h	1.25 KB	-rw-r--r--	2025-03-04 13:53
keytable.h	9.28 KB	-rw-r--r--	2025-03-04 13:53
keyvalues.h	4.06 KB	-rw-r--r--	2025-03-04 13:53
lib.h	1.16 KB	-rw-r--r--	2025-03-04 13:53
log.h	3.87 KB	-rw-r--r--	2025-03-04 13:53
lookup.h	2.85 KB	-rw-r--r--	2025-03-04 13:53
master.h	11.08 KB	-rw-r--r--	2025-03-04 13:53
masterdump.h	12.35 KB	-rw-r--r--	2025-03-04 13:53
message.h	37.27 KB	-rw-r--r--	2025-03-04 13:53
name.h	36.49 KB	-rw-r--r--	2025-03-04 13:53
ncache.h	4.8 KB	-rw-r--r--	2025-03-04 13:53
nsec.h	2.88 KB	-rw-r--r--	2025-03-04 13:53
nsec3.h	8.17 KB	-rw-r--r--	2025-03-04 13:53
nta.h	4.32 KB	-rw-r--r--	2025-03-04 13:53
opcode.h	1006 B	-rw-r--r--	2025-03-04 13:53
order.h	1.95 KB	-rw-r--r--	2025-03-04 13:53
peer.h	6.06 KB	-rw-r--r--	2025-03-04 13:53
portlist.h	2.05 KB	-rw-r--r--	2025-03-04 13:53
private.h	1.9 KB	-rw-r--r--	2025-03-04 13:53
rbt.h	39.7 KB	-rw-r--r--	2025-03-04 13:53
rcode.h	2.42 KB	-rw-r--r--	2025-03-04 13:53
rdata.h	20.92 KB	-rw-r--r--	2025-03-04 13:53
rdataclass.h	2.2 KB	-rw-r--r--	2025-03-04 13:53
rdatalist.h	2.51 KB	-rw-r--r--	2025-03-04 13:53
rdataset.h	20.85 KB	-rw-r--r--	2025-03-04 13:53
rdatasetiter.h	3.83 KB	-rw-r--r--	2025-03-04 13:53
rdataslab.h	4.29 KB	-rw-r--r--	2025-03-04 13:53
rdatastruct.h	57.57 KB	-rw-r--r--	2025-03-04 13:53
rdatatype.h	2.24 KB	-rw-r--r--	2025-03-04 13:53
request.h	10.89 KB	-rw-r--r--	2025-03-04 13:53
resolver.h	18.63 KB	-rw-r--r--	2025-03-04 13:53
result.h	8.57 KB	-rw-r--r--	2025-03-04 13:53
rootns.h	891 B	-rw-r--r--	2025-03-04 13:53
rpz.h	10.09 KB	-rw-r--r--	2025-03-04 13:53
rriterator.h	4.17 KB	-rw-r--r--	2025-03-04 13:53
rrl.h	6.49 KB	-rw-r--r--	2025-03-04 13:53
sdb.h	7.04 KB	-rw-r--r--	2025-03-04 13:53
sdlz.h	13.87 KB	-rw-r--r--	2025-03-04 13:53
secalg.h	1.67 KB	-rw-r--r--	2025-03-04 13:53
secproto.h	1.52 KB	-rw-r--r--	2025-03-04 13:53
soa.h	2.17 KB	-rw-r--r--	2025-03-04 13:53
ssu.h	8.09 KB	-rw-r--r--	2025-03-04 13:53
stats.h	13.15 KB	-rw-r--r--	2025-03-04 13:53
tcpmsg.h	3.05 KB	-rw-r--r--	2025-03-04 13:53
time.h	1.66 KB	-rw-r--r--	2025-03-04 13:53
timer.h	1.02 KB	-rw-r--r--	2025-03-04 13:53
tkey.h	7.43 KB	-rw-r--r--	2025-03-04 13:53
tsec.h	2.88 KB	-rw-r--r--	2025-03-04 13:53
tsig.h	8.06 KB	-rw-r--r--	2025-03-04 13:53
ttl.h	1.93 KB	-rw-r--r--	2025-03-04 13:53
types.h	13.65 KB	-rw-r--r--	2025-03-04 13:53
update.h	1.61 KB	-rw-r--r--	2025-03-04 13:53
validator.h	7.02 KB	-rw-r--r--	2025-03-04 13:53
version.h	867 B	-rw-r--r--	2025-03-04 13:53
view.h	34.69 KB	-rw-r--r--	2025-03-04 13:53
xfrin.h	2.85 KB	-rw-r--r--	2025-03-04 13:53
zone.h	59.8 KB	-rw-r--r--	2025-03-04 13:53
zonekey.h	763 B	-rw-r--r--	2025-03-04 13:53
zt.h	5.31 KB	-rw-r--r--	2025-03-04 13:53

Rename

/*
 * Copyright (C) Internet Systems Consortium, Inc. ("ISC")
 *
 * 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 http://mozilla.org/MPL/2.0/.
 *
 * See the COPYRIGHT file distributed with this work for additional
 * information regarding copyright ownership.
 */

#ifndef DNS_RDATASETITER_H
#define DNS_RDATASETITER_H 1

/*****
 ***** 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;
};

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

#endif /* DNS_RDATASETITER_H */