221 lines
4.9 KiB
C
221 lines
4.9 KiB
C
/*
|
|
* Copyright (C) 2000 Internet Software Consortium.
|
|
*
|
|
* Permission to use, copy, modify, and distribute this software for any
|
|
* purpose with or without fee is hereby granted, provided that the above
|
|
* copyright notice and this permission notice appear in all copies.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM DISCLAIMS
|
|
* ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL INTERNET SOFTWARE
|
|
* CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
|
|
* DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
|
|
* PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
|
|
* ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
|
|
* SOFTWARE.
|
|
*/
|
|
|
|
#ifndef DNS_REQUEST_H
|
|
#define DNS_REQUEST_H 1
|
|
|
|
/*****
|
|
***** Module Info
|
|
*****/
|
|
|
|
/*
|
|
* DNS Request
|
|
*
|
|
* The request module provides simple request/response services useful for
|
|
* sending SOA queries, DNS Notify messages, and dynamic update requests.
|
|
*
|
|
* MP:
|
|
* The module ensures appropriate synchronization of data structures it
|
|
* creates and manipulates.
|
|
*
|
|
* Resources:
|
|
* <TBS>
|
|
*
|
|
* Security:
|
|
* No anticipated impact.
|
|
*/
|
|
|
|
#include <isc/types.h>
|
|
#include <isc/lang.h>
|
|
#include <isc/event.h>
|
|
|
|
#include <dns/types.h>
|
|
#include <dns/result.h>
|
|
|
|
#define DNS_REQUESTOPT_TCP 0x00000001U
|
|
|
|
ISC_LANG_BEGINDECLS
|
|
|
|
typedef struct dns_requestevent {
|
|
ISC_EVENT_COMMON(struct dns_requestevent);
|
|
isc_result_t result;
|
|
dns_request_t *request;
|
|
} dns_requestevent_t;
|
|
|
|
isc_result_t
|
|
dns_requestmgr_create(isc_mem_t *mctx, isc_timermgr_t *timermgr,
|
|
isc_socketmgr_t *socketmgr,
|
|
dns_dispatch_t *dispatchv4, dns_dispatch_t *dispatchv6,
|
|
dns_requestmgr_t **requestmgrp);
|
|
/*
|
|
* Create a request manager.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 'mctx' is a valid memory context.
|
|
*
|
|
* 'timermgr' is a valid timer manager.
|
|
*
|
|
* 'socketmgr' is a valid socket manager.
|
|
*
|
|
* 'dispatchv4' is a valid dispatcher with an IPv4 UDP socket, or is NULL.
|
|
*
|
|
* 'dispatchv6' is a valid dispatcher with an IPv6 UDP socket, or is NULL.
|
|
*
|
|
* requestmgrp != NULL && *requestmgrp == NULL
|
|
*
|
|
* Ensures:
|
|
*
|
|
* On success, *requestmgrp is a valid request manager.
|
|
*
|
|
* Returns:
|
|
*
|
|
* ISC_R_SUCCESS
|
|
*
|
|
* 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:
|
|
*
|
|
* It is not safe to detach the last reference to 'requestmgr' until
|
|
* shutdown is complete.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 'requestmgr' is a valid request manager.
|
|
*
|
|
* 'task' is a valid task.
|
|
*
|
|
* *eventp is a valid event.
|
|
*
|
|
* Ensures:
|
|
*
|
|
* *eventp == NULL.
|
|
*/
|
|
|
|
void
|
|
dns_requestmgr_shutdown(dns_requestmgr_t *requestmgr);
|
|
/*
|
|
* Start the shutdown process for 'requestmgr'.
|
|
*
|
|
* Notes:
|
|
*
|
|
* This call has no effect if the request manager is already shutting
|
|
* down.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 'requestmgr' is a valid requestmgr.
|
|
*/
|
|
|
|
void
|
|
dns_requestmgr_attach(dns_requestmgr_t *source, dns_requestmgr_t **targetp);
|
|
|
|
void
|
|
dns_requestmgr_detach(dns_requestmgr_t **requestmgrp);
|
|
|
|
|
|
isc_result_t
|
|
dns_request_create(dns_requestmgr_t *requestmgr, dns_message_t *message,
|
|
isc_sockaddr_t *address, unsigned int options,
|
|
unsigned int timeout, isc_task_t *task,
|
|
isc_taskaction_t action, void *arg,
|
|
dns_request_t **requestp);
|
|
/*
|
|
* Create and send a request.
|
|
*
|
|
* Notes:
|
|
*
|
|
* 'message' will be rendered and sent to 'address'. If the
|
|
* DNS_REQUESTOPT_TCP option is set, TCP will be used. The request
|
|
* will timeout after 'timeout' seconds.
|
|
*
|
|
* When the request completes, successfully, due to a timeout, or
|
|
* because it was canceled, a completion event will be sent to 'task'.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 'message' is a valid DNS message.
|
|
*
|
|
* 'address' is a valid sockaddr.
|
|
*
|
|
* 'timeout' > 0
|
|
*
|
|
* 'task' is a valid task.
|
|
*
|
|
* requestp != NULL && *requestp == NULL
|
|
*/
|
|
|
|
isc_result_t
|
|
dns_request_cancel(dns_request_t *request);
|
|
/*
|
|
* Cancel 'request'.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 'request' is a valid request.
|
|
*
|
|
* Ensures:
|
|
*
|
|
* 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);
|
|
/*
|
|
* Get the response to 'request'.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 'request' is a valid request for which the caller has received the
|
|
* completion event.
|
|
*
|
|
* The result code of the completion event was ISC_R_SUCCESS.
|
|
*
|
|
* Returns:
|
|
*
|
|
* ISC_R_SUCCESS
|
|
*
|
|
* Any result that dns_message_parse() can return.
|
|
*/
|
|
|
|
void
|
|
dns_request_destroy(dns_request_t **requestp);
|
|
/*
|
|
* Destroy 'request'.
|
|
*
|
|
* Requires:
|
|
*
|
|
* 'request' is a valid request for which the caller has received the
|
|
* completion event.
|
|
*
|
|
* Ensures:
|
|
*
|
|
* *requestp == NULL
|
|
*/
|
|
|
|
ISC_LANG_ENDDECLS
|
|
|
|
#endif /* DNS_REQUEST_H */
|