FM / dns

/usr/include/bind9/dns

Name	Size	Mode	Actions
acache.h	14232	0644	edit dl rm
acl.h	7242	0644	edit dl rm
adb.h	22595	0644	edit dl rm
badcache.h	3369	0644	edit dl rm
bit.h	807	0644	edit dl rm
byaddr.h	4002	0644	edit dl rm
cache.h	8643	0644	edit dl rm
callbacks.h	2271	0644	edit dl rm
catz.h	11833	0644	edit dl rm
cert.h	1466	0644	edit dl rm
client.h	22042	0644	edit dl rm
clientinfo.h	2006	0644	edit dl rm
compress.h	6646	0644	edit dl rm
db.h	47061	0644	edit dl rm
dbiterator.h	7422	0644	edit dl rm
dbtable.h	3165	0644	edit dl rm
diff.h	6980	0644	edit dl rm
dispatch.h	16427	0644	edit dl rm
dlz.h	10618	0644	edit dl rm
dlz_dlopen.h	4677	0644	edit dl rm
dns64.h	5635	0644	edit dl rm
dnssec.h	12371	0644	edit dl rm
dnstap.h	9364	0644	edit dl rm
ds.h	1225	0644	edit dl rm
dsdigest.h	1722	0644	edit dl rm
dyndb.h	4835	0644	edit dl rm
ecdb.h	809	0644	edit dl rm
edns.h	722	0644	edit dl rm
enumclass.h	1220	0644	edit dl rm
enumtype.h	8300	0644	edit dl rm
events.h	4059	0644	edit dl rm
fixedname.h	1663	0644	edit dl rm
forward.h	3452	0644	edit dl rm
geoip.h	2792	0644	edit dl rm
ipkeylist.h	2186	0644	edit dl rm
iptable.h	1621	0644	edit dl rm
journal.h	8227	0644	edit dl rm
keydata.h	1059	0644	edit dl rm
keyflags.h	1278	0644	edit dl rm
keytable.h	9462	0644	edit dl rm
keyvalues.h	4159	0644	edit dl rm
lib.h	1192	0644	edit dl rm
log.h	3964	0644	edit dl rm
lookup.h	2924	0644	edit dl rm
master.h	11289	0644	edit dl rm
masterdump.h	12647	0644	edit dl rm
message.h	39023	0644	edit dl rm
name.h	37115	0644	edit dl rm
ncache.h	4929	0644	edit dl rm
nsec.h	3397	0644	edit dl rm
nsec3.h	8032	0644	edit dl rm
nta.h	4548	0644	edit dl rm
opcode.h	1007	0644	edit dl rm
order.h	1999	0644	edit dl rm
peer.h	5966	0644	edit dl rm
portlist.h	2101	0644	edit dl rm
private.h	1935	0644	edit dl rm
rbt.h	40618	0644	edit dl rm
rcode.h	2481	0644	edit dl rm
rdata.h	21613	0644	edit dl rm
rdataclass.h	2257	0644	edit dl rm
rdatalist.h	2569	0644	edit dl rm
rdataset.h	21536	0644	edit dl rm
rdatasetiter.h	3926	0644	edit dl rm
rdataslab.h	4528	0644	edit dl rm
rdatastruct.h	61584	0644	edit dl rm
rdatatype.h	2298	0644	edit dl rm
request.h	11156	0644	edit dl rm
resolver.h	20227	0644	edit dl rm
result.h	9284	0644	edit dl rm
rootns.h	892	0644	edit dl rm
rpz.h	10335	0644	edit dl rm
rriterator.h	4230	0644	edit dl rm
rrl.h	6640	0644	edit dl rm
sdb.h	7224	0644	edit dl rm
sdlz.h	14214	0644	edit dl rm
secalg.h	1706	0644	edit dl rm
secproto.h	1557	0644	edit dl rm
soa.h	2186	0644	edit dl rm
ssu.h	8308	0644	edit dl rm
stats.h	13451	0644	edit dl rm
tcpmsg.h	3145	0644	edit dl rm
time.h	1695	0644	edit dl rm
timer.h	1051	0644	edit dl rm
tkey.h	7631	0644	edit dl rm
tsec.h	2949	0644	edit dl rm
tsig.h	8384	0644	edit dl rm
ttl.h	1945	0644	edit dl rm
types.h	14212	0644	edit dl rm
update.h	1653	0644	edit dl rm
validator.h	7161	0644	edit dl rm
version.h	868	0644	edit dl rm
view.h	35274	0644	edit dl rm
xfrin.h	2924	0644	edit dl rm
zone.h	60864	0644	edit dl rm
zonekey.h	777	0644	edit dl rm
zt.h	5562	0644	edit dl rm

Edit: /usr/include/bind9/dns/dbiterator.h (7422B)

/*
 * 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 https://mozilla.org/MPL/2.0/.
 *
 * See the COPYRIGHT file distributed with this work for additional
 * information regarding copyright ownership.
 */

#ifndef DNS_DBITERATOR_H
#define DNS_DBITERATOR_H 1

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

/*! \file dns/dbiterator.h
 * \brief
 * The DNS DB Iterator interface allows iteration of all of the nodes in a
 * database.
 *
 * The dns_dbiterator_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_db_detachnode() on all
 * nodes returned.
 *
 * XXX &lt;more&gt; 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 <stdbool.h>

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

#include <dns/types.h>

ISC_LANG_BEGINDECLS

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

typedef struct dns_dbiteratormethods {
	void		(*destroy)(dns_dbiterator_t **iteratorp);
	isc_result_t	(*first)(dns_dbiterator_t *iterator);
	isc_result_t	(*last)(dns_dbiterator_t *iterator);
	isc_result_t	(*seek)(dns_dbiterator_t *iterator, dns_name_t *name);
	isc_result_t	(*prev)(dns_dbiterator_t *iterator);
	isc_result_t	(*next)(dns_dbiterator_t *iterator);
	isc_result_t	(*current)(dns_dbiterator_t *iterator,
				   dns_dbnode_t **nodep, dns_name_t *name);
	isc_result_t	(*pause)(dns_dbiterator_t *iterator);
	isc_result_t	(*origin)(dns_dbiterator_t *iterator,
				  dns_name_t *name);
} dns_dbiteratormethods_t;

#define DNS_DBITERATOR_MAGIC	     ISC_MAGIC('D','N','S','I')
#define DNS_DBITERATOR_VALID(dbi)    ISC_MAGIC_VALID(dbi, DNS_DBITERATOR_MAGIC)
/*%
 * This structure is actually just the common prefix of a DNS db
 * implementation's version of a dns_dbiterator_t.
 *
 * Clients may use the 'db' field of this structure.  Except for that field,
 * direct use of this structure by clients is forbidden.  DB implementations
 * may change the structure.  'magic' must be DNS_DBITERATOR_MAGIC for any of
 * the dns_dbiterator routines to work.  DB iterator implementations must
 * maintain all DB iterator invariants.
 */
struct dns_dbiterator {
	/* Unlocked. */
	unsigned int			magic;
	dns_dbiteratormethods_t *	methods;
	dns_db_t *			db;
	bool			relative_names;
	bool			cleaning;
};

void
dns_dbiterator_destroy(dns_dbiterator_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_dbiterator_first(dns_dbiterator_t *iterator);
/*%<
 * Move the node cursor to the first node in the database (if any).
 *
 * Requires:
 *\li	'iterator' is a valid iterator.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_NOMORE			There are no nodes in the database.
 *
 *\li	Other results are possible, depending on the DB implementation.
 */

isc_result_t
dns_dbiterator_last(dns_dbiterator_t *iterator);
/*%<
 * Move the node cursor to the last node in the database (if any).
 *
 * Requires:
 *\li	'iterator' is a valid iterator.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_NOMORE			There are no nodes in the database.
 *
 *\li	Other results are possible, depending on the DB implementation.
 */

isc_result_t
dns_dbiterator_seek(dns_dbiterator_t *iterator, dns_name_t *name);
/*%<
 * Move the node cursor to the node with name 'name'.
 *
 * Requires:
 *\li	'iterator' is a valid iterator.
 *
 *\li	'name' is a valid name.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_NOTFOUND
 *\li	#DNS_R_PARTIALMATCH
 *	(node is at name above requested named when name has children)
 *
 *\li	Other results are possible, depending on the DB implementation.
 */

isc_result_t
dns_dbiterator_prev(dns_dbiterator_t *iterator);
/*%<
 * Move the node cursor to the previous node in the database (if any).
 *
 * Requires:
 *\li	'iterator' is a valid iterator.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_NOMORE			There are no more nodes in the
 *					database.
 *
 *\li	Other results are possible, depending on the DB implementation.
 */

isc_result_t
dns_dbiterator_next(dns_dbiterator_t *iterator);
/*%<
 * Move the node cursor to the next node in the database (if any).
 *
 * Requires:
 *\li	'iterator' is a valid iterator.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_NOMORE			There are no more nodes in the
 *					database.
 *
 *\li	Other results are possible, depending on the DB implementation.
 */

isc_result_t
dns_dbiterator_current(dns_dbiterator_t *iterator, dns_dbnode_t **nodep,
		       dns_name_t *name);
/*%<
 * Return the current node.
 *
 * Notes:
 *\li	If 'name' is not NULL, it will be set to the name of the node.
 *
 * Requires:
 *\li	'iterator' is a valid iterator.
 *
 *\li	nodep != NULL && *nodep == NULL
 *
 *\li	The node cursor of 'iterator' is at a valid location (i.e. the
 *	result of last call to a cursor movement command was ISC_R_SUCCESS).
 *
 *\li	'name' is NULL, or is a valid name with a dedicated buffer.
 *
 * Returns:
 *
 *\li	#ISC_R_SUCCESS
 *\li	#DNS_R_NEWORIGIN			If this iterator was created with
 *					'relative_names' set to true,
 *					then #DNS_R_NEWORIGIN will be returned
 *					when the origin the names are
 *					relative to changes.  This result
 *					can occur only when 'name' is not
 *					NULL.  This is also a successful
 *					result.
 *
 *\li	Other results are possible, depending on the DB implementation.
 */

isc_result_t
dns_dbiterator_pause(dns_dbiterator_t *iterator);
/*%<
 * Pause iteration.
 *
 * Calling a cursor movement method or dns_dbiterator_current() may cause
 * database locks to be acquired.  Rather than reacquire these locks every
 * time one of these routines is called, the locks may simply be held.
 * Calling dns_dbiterator_pause() releases any such locks.  Iterator clients
 * should call this routine any time they are not going to execute another
 * iterator method in the immediate future.
 *
 * Requires:
 *\li	'iterator' is a valid iterator.
 *
 * Ensures:
 *\li	Any database locks being held for efficiency of iterator access are
 *	released.
 *
 * Returns:
 *\li	#ISC_R_SUCCESS
 *
 *\li	Other results are possible, depending on the DB implementation.
 */

isc_result_t
dns_dbiterator_origin(dns_dbiterator_t *iterator, dns_name_t *name);
/*%<
 * Return the origin to which returned node names are relative.
 *
 * Requires:
 *
 *\li	'iterator' is a valid relative_names iterator.
 *
 *\li	'name' is a valid name with a dedicated buffer.
 *
 * Returns:
 *
 *\li	#ISC_R_SUCCESS
 *\li	#ISC_R_NOSPACE
 *
 *\li	Other results are possible, depending on the DB implementation.
 */

void
dns_dbiterator_setcleanmode(dns_dbiterator_t *iterator, bool mode);
/*%<
 * Indicate that the given iterator is/is not cleaning the DB.
 *
 * Notes:
 *\li	When 'mode' is true,
 *
 * Requires:
 *\li	'iterator' is a valid iterator.
 */

ISC_LANG_ENDDECLS

#endif /* DNS_DBITERATOR_H */

cmd: