#acupoftea - mail.ontime-ae.com

System	:	Linux server1.ontime-gulf.com 4.18.0-553.5.1.el8_10.x86_64 #1 SMP Wed Jun 5 09:12:13 EDT 2024 x86_64
Software	:	Apache
Server	:	162.0.230.206
Domains	:	40 Domain
Permission	:	[ drwxr-xr-x ]
	:	/ usr / include / bind9 / dns /

216.73.216.49

Home

File request.h

/*
 * 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_REQUEST_H
#define DNS_REQUEST_H 1

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

/*! \file dns/request.h
 *
 * \brief
 * The request module provides simple request/response services useful for
 * sending SOA queries, DNS Notify messages, and dynamic update requests.
 *
 * MP:
 *\li	The module ensures appropriate synchronization of data structures it
 *	creates and manipulates.
 *
 * Resources:
 *\li	TBS
 *
 * Security:
 *\li	No anticipated impact.
 */

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

#include <dns/types.h>

#define DNS_REQUESTOPT_TCP 0x00000001U
#define DNS_REQUESTOPT_CASE 0x00000002U
#define DNS_REQUESTOPT_FIXEDID 0x00000004U
#define DNS_REQUESTOPT_SHARE 0x00000008U

typedef struct dns_requestevent {
	ISC_EVENT_COMMON(struct dns_requestevent);
	isc_result_t result;
	dns_request_t *request;
} dns_requestevent_t;

ISC_LANG_BEGINDECLS

isc_result_t
dns_requestmgr_create(isc_mem_t *mctx, isc_timermgr_t *timermgr,
		      isc_socketmgr_t *socketmgr, isc_taskmgr_t *taskmgr,
		      dns_dispatchmgr_t *dispatchmgr,
		      dns_dispatch_t *dispatchv4, dns_dispatch_t *dispatchv6,
		      dns_requestmgr_t **requestmgrp);
/*%<
 * Create a request manager.
 *
 * Requires:
 *
 *\li	'mctx' is a valid memory context.
 *
 *\li	'timermgr' is a valid timer manager.
 *
 *\li	'socketmgr' is a valid socket manager.
 *
 *\li	'taskmgr' is a valid task manager.
 *
 *\li	'dispatchv4' is a valid dispatcher with an IPv4 UDP socket, or is NULL.
 *
 *\li	'dispatchv6' is a valid dispatcher with an IPv6 UDP socket, or is NULL.
 *
 *\li	requestmgrp != NULL && *requestmgrp == NULL
 *
 * Ensures:
 *
 *\li	On success, *requestmgrp is a valid request manager.
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *
 *\li	Any other result indicates failure.
 */

void
dns_requestmgr_whenshutdown(dns_requestmgr_t *requestmgr, isc_task_t *task,
			    isc_event_t **eventp);
/*%<
 * Send '*eventp' to 'task' when 'requestmgr' has completed shutdown.
 *
 * Notes:
 *
 *\li	It is not safe to detach the last reference to 'requestmgr' until
 *	shutdown is complete.
 *
 * Requires:
 *
 *\li	'requestmgr' is a valid request manager.
 *
 *\li	'task' is a valid task.
 *
 *\li	*eventp is a valid event.
 *
 * Ensures:
 *
 *\li	*eventp == NULL.
 */

void
dns_requestmgr_shutdown(dns_requestmgr_t *requestmgr);
/*%<
 * Start the shutdown process for 'requestmgr'.
 *
 * Notes:
 *
 *\li	This call has no effect if the request manager is already shutting
 *	down.
 *
 * Requires:
 *
 *\li	'requestmgr' is a valid requestmgr.
 */

void
dns_requestmgr_attach(dns_requestmgr_t *source, dns_requestmgr_t **targetp);
/*%<
 *	Attach to the request manager.  dns_requestmgr_shutdown() must not
 *	have been called on 'source' prior to calling dns_requestmgr_attach().
 *
 * Requires:
 *
 *\li	'source' is a valid requestmgr.
 *
 *\li	'targetp' to be non NULL and '*targetp' to be NULL.
 */

void
dns_requestmgr_detach(dns_requestmgr_t **requestmgrp);
/*%<
 *	Detach from the given requestmgr.  If this is the final detach
 *	requestmgr will be destroyed.  dns_requestmgr_shutdown() must
 *	be called before the final detach.
 *
 * Requires:
 *
 *\li	'*requestmgrp' is a valid requestmgr.
 *
 * Ensures:
 *\li	'*requestmgrp' is NULL.
 */

isc_result_t
dns_request_create(dns_requestmgr_t *requestmgr, dns_message_t *message,
		   isc_sockaddr_t *address, unsigned int options,
		   dns_tsigkey_t *key,
		   unsigned int timeout, isc_task_t *task,
		   isc_taskaction_t action, void *arg,
		   dns_request_t **requestp);
/*%<
 * Create and send a request.
 *
 * Notes:
 *
 *\li	'message' will be rendered and sent to 'address'.  If the
 *	#DNS_REQUESTOPT_TCP option is set, TCP will be used,
 *	#DNS_REQUESTOPT_SHARE option is set too, connecting TCP
 *	(vs. connected) will be shared too.  The request
 *	will timeout after 'timeout' seconds.
 *
 *\li	If the #DNS_REQUESTOPT_CASE option is set, use case sensitive
 *	compression.
 *
 *\li	When the request completes, successfully, due to a timeout, or
 *	because it was canceled, a completion event will be sent to 'task'.
 *
 * Requires:
 *
 *\li	'message' is a valid DNS message.
 *
 *\li	'address' is a valid sockaddr.
 *
 *\li	'timeout' > 0
 *
 *\li	'task' is a valid task.
 *
 *\li	requestp != NULL && *requestp == NULL
 */

/*% See dns_request_createvia4() */
isc_result_t
dns_request_createvia(dns_requestmgr_t *requestmgr, dns_message_t *message,
		      isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
		      unsigned int options, dns_tsigkey_t *key,
		      unsigned int timeout, isc_task_t *task,
		      isc_taskaction_t action, void *arg,
		      dns_request_t **requestp);

/*% See dns_request_createvia4() */
isc_result_t
dns_request_createvia2(dns_requestmgr_t *requestmgr, dns_message_t *message,
		       isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
		       unsigned int options, dns_tsigkey_t *key,
		       unsigned int timeout, unsigned int udptimeout,
		       isc_task_t *task, isc_taskaction_t action, void *arg,
		       dns_request_t **requestp);

/*% See dns_request_createvia4() */
isc_result_t
dns_request_createvia3(dns_requestmgr_t *requestmgr, dns_message_t *message,
		       isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
		       unsigned int options, dns_tsigkey_t *key,
		       unsigned int timeout, unsigned int udptimeout,
		       unsigned int udpretries, isc_task_t *task,
		       isc_taskaction_t action, void *arg,
		       dns_request_t **requestp);

isc_result_t
dns_request_createvia4(dns_requestmgr_t *requestmgr, dns_message_t *message,
		       isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
		       isc_dscp_t dscp, unsigned int options,
		       dns_tsigkey_t *key, unsigned int timeout,
		       unsigned int udptimeout, unsigned int udpretries,
		       isc_task_t *task, isc_taskaction_t action, void *arg,
		       dns_request_t **requestp);
/*%<
 * Create and send a request.
 *
 * Notes:
 *
 *\li	'message' will be rendered and sent to 'address'.  If the
 *	#DNS_REQUESTOPT_TCP option is set, TCP will be used,
 *	#DNS_REQUESTOPT_SHARE option is set too, connecting TCP
 *	(vs. connected) will be shared too.  The request
 *	will timeout after 'timeout' seconds.  UDP requests will be resent
 *	at 'udptimeout' intervals if non-zero or 'udpretries' is non-zero.
 *
 *\li	If the #DNS_REQUESTOPT_CASE option is set, use case sensitive
 *	compression.
 *
 *\li	When the request completes, successfully, due to a timeout, or
 *	because it was canceled, a completion event will be sent to 'task'.
 *
 * Requires:
 *
 *\li	'message' is a valid DNS message.
 *
 *\li	'dstaddr' is a valid sockaddr.
 *
 *\li	'srcaddr' is a valid sockaddr or NULL.
 *
 *\li	'srcaddr' and 'dstaddr' are the same protocol family.
 *
 *\li	'timeout' > 0
 *
 *\li	'task' is a valid task.
 *
 *\li	requestp != NULL && *requestp == NULL
 */

/*% See dns_request_createraw4() */
isc_result_t
dns_request_createraw(dns_requestmgr_t *requestmgr, isc_buffer_t *msgbuf,
		      isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
		      unsigned int options, unsigned int timeout,
		      isc_task_t *task, isc_taskaction_t action, void *arg,
		      dns_request_t **requestp);

/*% See dns_request_createraw4() */
isc_result_t
dns_request_createraw2(dns_requestmgr_t *requestmgr, isc_buffer_t *msgbuf,
		       isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
		       unsigned int options, unsigned int timeout,
		       unsigned int udptimeout, isc_task_t *task,
		       isc_taskaction_t action, void *arg,
		       dns_request_t **requestp);

/*% See dns_request_createraw4() */
isc_result_t
dns_request_createraw3(dns_requestmgr_t *requestmgr, isc_buffer_t *msgbuf,
		       isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
		       unsigned int options, unsigned int timeout,
		       unsigned int udptimeout, unsigned int udpretries,
		       isc_task_t *task, isc_taskaction_t action, void *arg,
		       dns_request_t **requestp);

isc_result_t
dns_request_createraw4(dns_requestmgr_t *requestmgr, isc_buffer_t *msgbuf,
		       isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
		       isc_dscp_t dscp, unsigned int options,
		       unsigned int timeout, unsigned int udptimeout,
		       unsigned int udpretries, isc_task_t *task,
		       isc_taskaction_t action, void *arg,
		       dns_request_t **requestp);
/*!<
 * \brief Create and send a request.
 *
 * Notes:
 *
 *\li	'msgbuf' will be sent to 'destaddr' after setting the id.  If the
 *	#DNS_REQUESTOPT_TCP option is set, TCP will be used,
 *	#DNS_REQUESTOPT_SHARE option is set too, connecting TCP
 *	(vs. connected) will be shared too.  The request
 *	will timeout after 'timeout' seconds.   UDP requests will be resent
 *	at 'udptimeout' intervals if non-zero or if 'udpretries' is not zero.
 *
 *\li	When the request completes, successfully, due to a timeout, or
 *	because it was canceled, a completion event will be sent to 'task'.
 *
 * Requires:
 *
 *\li	'msgbuf' is a valid DNS message in compressed wire format.
 *
 *\li	'destaddr' is a valid sockaddr.
 *
 *\li	'srcaddr' is a valid sockaddr or NULL.
 *
 *\li	'srcaddr' and 'dstaddr' are the same protocol family.
 *
 *\li	'timeout' > 0
 *
 *\li	'task' is a valid task.
 *
 *\li	requestp != NULL && *requestp == NULL
 */

void
dns_request_cancel(dns_request_t *request);
/*%<
 * Cancel 'request'.
 *
 * Requires:
 *
 *\li	'request' is a valid request.
 *
 * Ensures:
 *
 *\li	If the completion event for 'request' has not yet been sent, it
 *	will be sent, and the result code will be ISC_R_CANCELED.
 */

isc_result_t
dns_request_getresponse(dns_request_t *request, dns_message_t *message,
			unsigned int options);
/*%<
 * Get the response to 'request' by filling in 'message'.
 *
 * 'options' is passed to dns_message_parse().  See dns_message_parse()
 * for more details.
 *
 * Requires:
 *
 *\li	'request' is a valid request for which the caller has received the
 *	completion event.
 *
 *\li	The result code of the completion event was #ISC_R_SUCCESS.
 *
 * Returns:
 *
 *\li	ISC_R_SUCCESS
 *
 *\li	Any result that dns_message_parse() can return.
 */

bool
dns_request_usedtcp(dns_request_t *request);
/*%<
 * Return whether this query used TCP or not.  Setting #DNS_REQUESTOPT_TCP
 * in the call to dns_request_create() will cause the function to return
 * #true, otherwise the result is based on the query message size.
 *
 * Requires:
 *\li	'request' is a valid request.
 *
 * Returns:
 *\li	true	if TCP was used.
 *\li	false	if UDP was used.
 */

void
dns_request_destroy(dns_request_t **requestp);
/*%<
 * Destroy 'request'.
 *
 * Requires:
 *
 *\li	'request' is a valid request for which the caller has received the
 *	completion event.
 *
 * Ensures:
 *
 *\li	*requestp == NULL
 */

ISC_LANG_ENDDECLS

#endif /* DNS_REQUEST_H */

Name	Type	Size	Permission	Last Modified	Actions
.	DIR	-	drwxr-xr-x	2025-02-21 10:57:15
..	DIR	-	drwxr-xr-x	2025-02-21 10:57:16
acache.h	text/x-c	13.9 KB	-rw-r--r--	2025-02-20 09:05:25
acl.h	text/x-c	7.07 KB	-rw-r--r--	2025-02-20 09:05:25
adb.h	text/x-c	22.07 KB	-rw-r--r--	2025-02-20 09:05:25
badcache.h	text/x-c	3.29 KB	-rw-r--r--	2025-02-20 09:05:25
bit.h	text/x-c	807 B	-rw-r--r--	2025-02-20 09:05:25
byaddr.h	text/x-c	3.91 KB	-rw-r--r--	2025-02-20 09:05:25
cache.h	text/x-c	8.44 KB	-rw-r--r--	2025-02-20 09:05:25
callbacks.h	text/x-c	2.22 KB	-rw-r--r--	2025-02-20 09:05:25
catz.h	text/x-c	11.56 KB	-rw-r--r--	2025-02-20 09:05:25
cert.h	text/x-c	1.43 KB	-rw-r--r--	2025-02-20 09:05:25
client.h	text/x-c	21.53 KB	-rw-r--r--	2025-02-20 09:05:25
clientinfo.h	text/x-c	1.96 KB	-rw-r--r--	2025-02-20 09:05:25
compress.h	text/x-c	6.49 KB	-rw-r--r--	2025-02-20 09:05:25
db.h	text/x-c	45.48 KB	-rw-r--r--	2025-02-20 09:05:25
dbiterator.h	text/x-c	7.25 KB	-rw-r--r--	2025-02-20 09:05:25
dbtable.h	text/x-c	3.09 KB	-rw-r--r--	2025-02-20 09:05:25
diff.h	text/x-c	6.82 KB	-rw-r--r--	2025-02-20 09:05:25
dispatch.h	text/x-c	16.04 KB	-rw-r--r--	2025-02-20 09:05:25
dlz.h	text/x-c	10.37 KB	-rw-r--r--	2025-02-20 09:05:25
dlz_dlopen.h	text/x-c	4.57 KB	-rw-r--r--	2025-02-20 09:05:25
dns64.h	text/x-c	5.5 KB	-rw-r--r--	2025-02-20 09:05:25
dnssec.h	text/x-c	11.83 KB	-rw-r--r--	2025-02-20 09:05:25
dnstap.h	text/x-c	9.14 KB	-rw-r--r--	2025-02-20 09:05:25
ds.h	text/x-c	1.2 KB	-rw-r--r--	2025-02-20 09:05:25
dsdigest.h	text/x-c	1.68 KB	-rw-r--r--	2025-02-20 09:05:25
dyndb.h	text/x-c	4.72 KB	-rw-r--r--	2025-02-20 09:05:25
ecdb.h	text/x-c	809 B	-rw-r--r--	2025-02-20 09:05:25
edns.h	text/plain	722 B	-rw-r--r--	2025-02-20 09:05:25
enumclass.h	text/plain	1.19 KB	-rw-r--r--	2025-02-20 09:05:25
enumtype.h	text/plain	8.11 KB	-rw-r--r--	2025-02-20 09:05:25
events.h	text/x-c	3.96 KB	-rw-r--r--	2025-02-20 09:05:25
fixedname.h	text/x-c	1.62 KB	-rw-r--r--	2025-02-20 09:05:25
forward.h	text/x-c	3.37 KB	-rw-r--r--	2025-02-20 09:05:25
geoip.h	text/x-c	2.73 KB	-rw-r--r--	2025-02-20 09:05:25
ipkeylist.h	text/x-c	2.13 KB	-rw-r--r--	2025-02-20 09:05:25
iptable.h	text/x-c	1.58 KB	-rw-r--r--	2025-02-20 09:05:25
journal.h	text/x-c	8.03 KB	-rw-r--r--	2025-02-20 09:05:25
keydata.h	text/x-c	1.03 KB	-rw-r--r--	2025-02-20 09:05:25
keyflags.h	text/x-c	1.25 KB	-rw-r--r--	2025-02-20 09:05:25
keytable.h	text/x-c	9.24 KB	-rw-r--r--	2025-02-20 09:05:25
keyvalues.h	text/plain	4.06 KB	-rw-r--r--	2025-02-20 09:05:25
lib.h	text/x-c	1.16 KB	-rw-r--r--	2025-02-20 09:05:25
log.h	text/x-c	3.87 KB	-rw-r--r--	2025-02-20 09:05:25
lookup.h	text/x-c	2.86 KB	-rw-r--r--	2025-02-20 09:05:25
master.h	text/x-c	11.02 KB	-rw-r--r--	2025-02-20 09:05:25
masterdump.h	text/x-c	12.35 KB	-rw-r--r--	2025-02-20 09:05:25
message.h	text/x-c	37.92 KB	-rw-r--r--	2025-02-20 09:05:25
name.h	text/x-c	36.25 KB	-rw-r--r--	2025-02-20 09:05:25
ncache.h	text/x-c	4.81 KB	-rw-r--r--	2025-02-20 09:05:25
nsec.h	text/x-c	2.86 KB	-rw-r--r--	2025-02-20 09:05:25
nsec3.h	text/x-c	7.84 KB	-rw-r--r--	2025-02-20 09:05:25
nta.h	text/x-c	4.44 KB	-rw-r--r--	2025-02-20 09:05:25
opcode.h	text/x-c	1007 B	-rw-r--r--	2025-02-20 09:05:25
order.h	text/x-c	1.95 KB	-rw-r--r--	2025-02-20 09:05:25
peer.h	text/x-c	5.83 KB	-rw-r--r--	2025-02-20 09:05:25
portlist.h	text/x-c	2.05 KB	-rw-r--r--	2025-02-20 09:05:25
private.h	text/x-c	1.89 KB	-rw-r--r--	2025-02-20 09:05:25
rbt.h	text/x-c	39.67 KB	-rw-r--r--	2025-02-20 09:05:25
rcode.h	text/x-c	2.42 KB	-rw-r--r--	2025-02-20 09:05:25
rdata.h	text/x-c	21.11 KB	-rw-r--r--	2025-02-20 09:05:25
rdataclass.h	text/x-c	2.2 KB	-rw-r--r--	2025-02-20 09:05:25
rdatalist.h	text/x-c	2.51 KB	-rw-r--r--	2025-02-20 09:05:25
rdataset.h	text/x-c	21.03 KB	-rw-r--r--	2025-02-20 09:05:25
rdatasetiter.h	text/x-c	3.83 KB	-rw-r--r--	2025-02-20 09:05:25
rdataslab.h	text/x-c	4.28 KB	-rw-r--r--	2025-02-20 09:05:25
rdatastruct.h	text/x-c	60.14 KB	-rw-r--r--	2025-02-20 09:05:25
rdatatype.h	text/x-c	2.24 KB	-rw-r--r--	2025-02-20 09:05:25
request.h	text/x-c	10.89 KB	-rw-r--r--	2025-02-20 09:05:25
resolver.h	text/x-c	19.75 KB	-rw-r--r--	2025-02-20 09:05:25
result.h	text/x-c	9.07 KB	-rw-r--r--	2025-02-20 09:05:25
rootns.h	text/x-c	892 B	-rw-r--r--	2025-02-20 09:05:25
rpz.h	text/x-c	10.09 KB	-rw-r--r--	2025-02-20 09:05:25
rriterator.h	text/x-c	4.13 KB	-rw-r--r--	2025-02-20 09:05:25
rrl.h	text/x-c	6.48 KB	-rw-r--r--	2025-02-20 09:05:25
sdb.h	text/x-c	7.05 KB	-rw-r--r--	2025-02-20 09:05:25
sdlz.h	text/x-c	13.88 KB	-rw-r--r--	2025-02-20 09:05:25
secalg.h	text/x-c	1.67 KB	-rw-r--r--	2025-02-20 09:05:25
secproto.h	text/x-c	1.52 KB	-rw-r--r--	2025-02-20 09:05:25
soa.h	text/x-c	2.13 KB	-rw-r--r--	2025-02-20 09:05:25
ssu.h	text/x-c	8.11 KB	-rw-r--r--	2025-02-20 09:05:25
stats.h	text/x-c	13.14 KB	-rw-r--r--	2025-02-20 09:05:25
tcpmsg.h	text/x-c	3.07 KB	-rw-r--r--	2025-02-20 09:05:25
time.h	text/x-c	1.66 KB	-rw-r--r--	2025-02-20 09:05:25
timer.h	text/x-c	1.03 KB	-rw-r--r--	2025-02-20 09:05:25
tkey.h	text/x-c	7.45 KB	-rw-r--r--	2025-02-20 09:05:25
tsec.h	text/x-c	2.88 KB	-rw-r--r--	2025-02-20 09:05:25
tsig.h	text/x-c	8.19 KB	-rw-r--r--	2025-02-20 09:05:25
ttl.h	text/x-c	1.9 KB	-rw-r--r--	2025-02-20 09:05:25
types.h	text/x-c	13.83 KB	-rw-r--r--	2025-02-20 09:05:25
update.h	text/x-c	1.61 KB	-rw-r--r--	2025-02-20 09:05:25
validator.h	text/x-c	6.99 KB	-rw-r--r--	2025-02-20 09:05:25
version.h	text/x-c	868 B	-rw-r--r--	2025-02-20 09:05:25
view.h	text/x-c	34.45 KB	-rw-r--r--	2025-02-20 09:05:25
xfrin.h	text/x-c	2.86 KB	-rw-r--r--	2025-02-20 09:05:25
zone.h	text/x-c	59.44 KB	-rw-r--r--	2025-02-20 09:05:25
zonekey.h	text/x-c	777 B	-rw-r--r--	2025-02-20 09:05:25
zt.h	text/x-c	5.43 KB	-rw-r--r--	2025-02-20 09:05:25

~ ACUPOFTEA - mail.ontime-ae.com