ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / include / bind9 / dns

/*
 * 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_LOOKUP_H
#define DNS_LOOKUP_H 1

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

/*! \file dns/lookup.h
 * \brief
 * The lookup module performs simple DNS lookups.  It implements
 * the full resolver algorithm, both looking for local data and
 * resolving external names as necessary.
 *
 * MP:
 *\li	The module ensures appropriate synchronization of data structures it
 *	creates and manipulates.
 *
 * Reliability:
 *\li	No anticipated impact.
 *
 * Resources:
 *\li	TBS
 *
 * Security:
 *\li	No anticipated impact.
 *
 * Standards:
 *\li	RFCs:	1034, 1035, 2181, TBS
 *\li	Drafts:	TBS
 */

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

#include <dns/types.h>

ISC_LANG_BEGINDECLS

/*%
 * A 'dns_lookupevent_t' is returned when a lookup completes.
 * The sender field will be set to the lookup that completed.  If 'result'
 * is ISC_R_SUCCESS, then 'names' will contain a list of names associated
 * with the address.  The recipient of the event must not change the list
 * and must not refer to any of the name data after the event is freed.
 */
typedef struct dns_lookupevent {
	ISC_EVENT_COMMON(struct dns_lookupevent);
	isc_result_t			result;
	dns_name_t			*name;
	dns_rdataset_t			*rdataset;
	dns_rdataset_t			*sigrdataset;
	dns_db_t			*db;
	dns_dbnode_t			*node;
} dns_lookupevent_t;

isc_result_t
dns_lookup_create(isc_mem_t *mctx, dns_name_t *name, dns_rdatatype_t type,
		  dns_view_t *view, unsigned int options, isc_task_t *task,
		  isc_taskaction_t action, void *arg, dns_lookup_t **lookupp);
/*%<
 * Finds the rrsets matching 'name' and 'type'.
 *
 * Requires:
 *
 *\li	'mctx' is a valid mctx.
 *
 *\li	'name' is a valid name.
 *
 *\li	'view' is a valid view which has a resolver.
 *
 *\li	'task' is a valid task.
 *
 *\li	lookupp != NULL && *lookupp == NULL
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *\li	ISC_R_NOMEMORY
 *
 *\li	Any resolver-related error (e.g. ISC_R_SHUTTINGDOWN) may also be
 *	returned.
 */

void
dns_lookup_cancel(dns_lookup_t *lookup);
/*%<
 * Cancel 'lookup'.
 *
 * Notes:
 *
 *\li	If 'lookup' has not completed, post its LOOKUPDONE event with a
 *	result code of ISC_R_CANCELED.
 *
 * Requires:
 *
 *\li	'lookup' is a valid lookup.
 */

void
dns_lookup_destroy(dns_lookup_t **lookupp);
/*%<
 * Destroy 'lookup'.
 *
 * Requires:
 *
 *\li	'*lookupp' is a valid lookup.
 *
 *\li	The caller has received the LOOKUPDONE event (either because the
 *	lookup completed or because dns_lookup_cancel() was called).
 *
 * Ensures:
 *
 *\li	*lookupp == NULL.
 */

ISC_LANG_ENDDECLS

#endif /* DNS_LOOKUP_H */

[-] diff.h [edit]
[-] callbacks.h [edit]
[-] badcache.h [edit]
[-] version.h [edit]
[-] rdataslab.h [edit]
[-] nsec3.h [edit]
[-] dlz_dlopen.h [edit]
[-] validator.h [edit]
[-] rdatasetiter.h [edit]
[-] rriterator.h [edit]
[-] rdata.h [edit]
[-] stats.h [edit]
[+] ..
[-] opcode.h [edit]
[-] dbtable.h [edit]
[-] geoip.h [edit]
[-] catz.h [edit]
[-] journal.h [edit]
[-] zt.h [edit]
[-] tkey.h [edit]
[-] rdatatype.h [edit]
[-] result.h [edit]
[-] view.h [edit]
[-] acache.h [edit]
[-] message.h [edit]
[-] byaddr.h [edit]
[-] dsdigest.h [edit]
[-] rdatastruct.h [edit]
[-] clientinfo.h [edit]
[-] rbt.h [edit]
[-] sdlz.h [edit]
[-] cache.h [edit]
[-] zonekey.h [edit]
[-] acl.h [edit]
[-] enumclass.h [edit]
[-] log.h [edit]
[-] portlist.h [edit]
[-] rdataset.h [edit]
[-] tcpmsg.h [edit]
[-] client.h [edit]
[-] zone.h [edit]
[-] time.h [edit]
[-] xfrin.h [edit]
[-] secproto.h [edit]
[-] rcode.h [edit]
[-] dyndb.h [edit]
[-] peer.h [edit]
[-] ttl.h [edit]
[-] types.h [edit]
[-] rrl.h [edit]
[-] rootns.h [edit]
[-] keytable.h [edit]
[-] forward.h [edit]
[-] ipkeylist.h [edit]
[-] timer.h [edit]
[-] ds.h [edit]
[-] dnstap.h [edit]
[-] dispatch.h [edit]
[-] private.h [edit]
[-] ssu.h [edit]
[-] order.h [edit]
[-] update.h [edit]
[-] rdatalist.h [edit]
[-] lookup.h [edit]
[-] db.h [edit]
[-] name.h [edit]
[-] ncache.h [edit]
[-] nta.h [edit]
[-] ecdb.h [edit]
[-] iptable.h [edit]
[-] resolver.h [edit]
[-] masterdump.h [edit]
[-] nsec.h [edit]
[-] cert.h [edit]
[-] soa.h [edit]
[-] bit.h [edit]
[-] events.h [edit]
[-] dnssec.h [edit]
[-] dbiterator.h [edit]
[-] request.h [edit]
[-] keyflags.h [edit]
[-] secalg.h [edit]
[-] dns64.h [edit]
[-] edns.h [edit]
[-] enumtype.h [edit]
[-] fixedname.h [edit]
[-] tsec.h [edit]
[-] lib.h [edit]
[-] keyvalues.h [edit]
[-] keydata.h [edit]
[-] sdb.h [edit]
[-] adb.h [edit]
[-] compress.h [edit]
[-] rdataclass.h [edit]
[-] dlz.h [edit]
[-] tsig.h [edit]
[-] master.h [edit]
[-] rpz.h [edit]