2 * Copyright (C) 2004-2007, 2009 Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 2000-2002 Internet Software Consortium.
5 * Permission to use, copy, modify, and/or distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
9 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 * PERFORMANCE OF THIS SOFTWARE.
18 /* $Id: request.h,v 1.27.332.2 2009/01/18 23:47:41 tbox Exp $ */
21 #define DNS_REQUEST_H 1
27 /*! \file dns/request.h
30 * The request module provides simple request/response services useful for
31 * sending SOA queries, DNS Notify messages, and dynamic update requests.
34 *\li The module ensures appropriate synchronization of data structures it
35 * creates and manipulates.
41 *\li No anticipated impact.
45 #include <isc/event.h>
47 #include <dns/types.h>
49 #define DNS_REQUESTOPT_TCP 0x00000001U
51 typedef struct dns_requestevent {
52 ISC_EVENT_COMMON(struct dns_requestevent);
54 dns_request_t *request;
60 dns_requestmgr_create(isc_mem_t *mctx, isc_timermgr_t *timermgr,
61 isc_socketmgr_t *socketmgr, isc_taskmgr_t *taskmgr,
62 dns_dispatchmgr_t *dispatchmgr,
63 dns_dispatch_t *dispatchv4, dns_dispatch_t *dispatchv6,
64 dns_requestmgr_t **requestmgrp);
66 * Create a request manager.
70 *\li 'mctx' is a valid memory context.
72 *\li 'timermgr' is a valid timer manager.
74 *\li 'socketmgr' is a valid socket manager.
76 *\li 'taskmgr' is a valid task manager.
78 *\li 'dispatchv4' is a valid dispatcher with an IPv4 UDP socket, or is NULL.
80 *\li 'dispatchv6' is a valid dispatcher with an IPv6 UDP socket, or is NULL.
82 *\li requestmgrp != NULL && *requestmgrp == NULL
86 *\li On success, *requestmgrp is a valid request manager.
92 *\li Any other result indicates failure.
96 dns_requestmgr_whenshutdown(dns_requestmgr_t *requestmgr, isc_task_t *task,
97 isc_event_t **eventp);
99 * Send '*eventp' to 'task' when 'requestmgr' has completed shutdown.
103 *\li It is not safe to detach the last reference to 'requestmgr' until
104 * shutdown is complete.
108 *\li 'requestmgr' is a valid request manager.
110 *\li 'task' is a valid task.
112 *\li *eventp is a valid event.
116 *\li *eventp == NULL.
120 dns_requestmgr_shutdown(dns_requestmgr_t *requestmgr);
122 * Start the shutdown process for 'requestmgr'.
126 *\li This call has no effect if the request manager is already shutting
131 *\li 'requestmgr' is a valid requestmgr.
135 dns_requestmgr_attach(dns_requestmgr_t *source, dns_requestmgr_t **targetp);
137 * Attach to the request manager. dns_requestmgr_shutdown() must not
138 * have been called on 'source' prior to calling dns_requestmgr_attach().
142 *\li 'source' is a valid requestmgr.
144 *\li 'targetp' to be non NULL and '*targetp' to be NULL.
148 dns_requestmgr_detach(dns_requestmgr_t **requestmgrp);
150 * Detach from the given requestmgr. If this is the final detach
151 * requestmgr will be destroyed. dns_requestmgr_shutdown() must
152 * be called before the final detach.
156 *\li '*requestmgrp' is a valid requestmgr.
159 *\li '*requestmgrp' is NULL.
163 dns_request_create(dns_requestmgr_t *requestmgr, dns_message_t *message,
164 isc_sockaddr_t *address, unsigned int options,
166 unsigned int timeout, isc_task_t *task,
167 isc_taskaction_t action, void *arg,
168 dns_request_t **requestp);
170 * Create and send a request.
174 *\li 'message' will be rendered and sent to 'address'. If the
175 * #DNS_REQUESTOPT_TCP option is set, TCP will be used. The request
176 * will timeout after 'timeout' seconds.
178 *\li When the request completes, successfully, due to a timeout, or
179 * because it was canceled, a completion event will be sent to 'task'.
183 *\li 'message' is a valid DNS message.
185 *\li 'address' is a valid sockaddr.
189 *\li 'task' is a valid task.
191 *\li requestp != NULL && *requestp == NULL
194 /*% See dns_request_createvia3() */
196 dns_request_createvia(dns_requestmgr_t *requestmgr, dns_message_t *message,
197 isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
198 unsigned int options, dns_tsigkey_t *key,
199 unsigned int timeout, isc_task_t *task,
200 isc_taskaction_t action, void *arg,
201 dns_request_t **requestp);
203 /*% See dns_request_createvia3() */
205 dns_request_createvia2(dns_requestmgr_t *requestmgr, dns_message_t *message,
206 isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
207 unsigned int options, dns_tsigkey_t *key,
208 unsigned int timeout, unsigned int udptimeout,
209 isc_task_t *task, isc_taskaction_t action, void *arg,
210 dns_request_t **requestp);
213 dns_request_createvia3(dns_requestmgr_t *requestmgr, dns_message_t *message,
214 isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
215 unsigned int options, dns_tsigkey_t *key,
216 unsigned int timeout, unsigned int udptimeout,
217 unsigned int udpretries, isc_task_t *task,
218 isc_taskaction_t action, void *arg,
219 dns_request_t **requestp);
221 * Create and send a request.
225 *\li 'message' will be rendered and sent to 'address'. If the
226 * #DNS_REQUESTOPT_TCP option is set, TCP will be used. The request
227 * will timeout after 'timeout' seconds. UDP requests will be resent
228 * at 'udptimeout' intervals if non-zero or 'udpretries' is non-zero.
230 *\li When the request completes, successfully, due to a timeout, or
231 * because it was canceled, a completion event will be sent to 'task'.
235 *\li 'message' is a valid DNS message.
237 *\li 'dstaddr' is a valid sockaddr.
239 *\li 'srcaddr' is a valid sockaddr or NULL.
241 *\li 'srcaddr' and 'dstaddr' are the same protocol family.
245 *\li 'task' is a valid task.
247 *\li requestp != NULL && *requestp == NULL
250 /*% See dns_request_createraw3() */
252 dns_request_createraw(dns_requestmgr_t *requestmgr, isc_buffer_t *msgbuf,
253 isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
254 unsigned int options, unsigned int timeout,
255 isc_task_t *task, isc_taskaction_t action, void *arg,
256 dns_request_t **requestp);
258 /*% See dns_request_createraw3() */
260 dns_request_createraw2(dns_requestmgr_t *requestmgr, isc_buffer_t *msgbuf,
261 isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
262 unsigned int options, unsigned int timeout,
263 unsigned int udptimeout, isc_task_t *task,
264 isc_taskaction_t action, void *arg,
265 dns_request_t **requestp);
268 dns_request_createraw3(dns_requestmgr_t *requestmgr, isc_buffer_t *msgbuf,
269 isc_sockaddr_t *srcaddr, isc_sockaddr_t *destaddr,
270 unsigned int options, unsigned int timeout,
271 unsigned int udptimeout, unsigned int udpretries,
272 isc_task_t *task, isc_taskaction_t action, void *arg,
273 dns_request_t **requestp);
275 * \brief Create and send a request.
279 *\li 'msgbuf' will be sent to 'destaddr' after setting the id. If the
280 * #DNS_REQUESTOPT_TCP option is set, TCP will be used. The request
281 * will timeout after 'timeout' seconds. UDP requests will be resent
282 * at 'udptimeout' intervals if non-zero or if 'udpretries' is not zero.
284 *\li When the request completes, successfully, due to a timeout, or
285 * because it was canceled, a completion event will be sent to 'task'.
289 *\li 'msgbuf' is a valid DNS message in compressed wire format.
291 *\li 'destaddr' is a valid sockaddr.
293 *\li 'srcaddr' is a valid sockaddr or NULL.
295 *\li 'srcaddr' and 'dstaddr' are the same protocol family.
299 *\li 'task' is a valid task.
301 *\li requestp != NULL && *requestp == NULL
305 dns_request_cancel(dns_request_t *request);
311 *\li 'request' is a valid request.
315 *\li If the completion event for 'request' has not yet been sent, it
316 * will be sent, and the result code will be ISC_R_CANCELED.
320 dns_request_getresponse(dns_request_t *request, dns_message_t *message,
321 unsigned int options);
323 * Get the response to 'request' by filling in 'message'.
325 * 'options' is passed to dns_message_parse(). See dns_message_parse()
330 *\li 'request' is a valid request for which the caller has received the
333 *\li The result code of the completion event was #ISC_R_SUCCESS.
339 *\li Any result that dns_message_parse() can return.
343 dns_request_usedtcp(dns_request_t *request);
345 * Return whether this query used TCP or not. Setting #DNS_REQUESTOPT_TCP
346 * in the call to dns_request_create() will cause the function to return
347 * #ISC_TRUE, otherwise the result is based on the query message size.
350 *\li 'request' is a valid request.
353 *\li ISC_TRUE if TCP was used.
354 *\li ISC_FALSE if UDP was used.
358 dns_request_destroy(dns_request_t **requestp);
364 *\li 'request' is a valid request for which the caller has received the
369 *\li *requestp == NULL
374 #endif /* DNS_REQUEST_H */