1/*
2 * Copyright (C) 2004-2007, 2009  Internet Systems Consortium, Inc. ("ISC")
3 * Copyright (C) 2001  Internet Software Consortium.
4 *
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.
8 *
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.
16 */
17
18/* $Id: getaddresses.h,v 1.11 2009/01/17 23:47:42 tbox Exp $ */
19
20#ifndef BIND9_GETADDRESSES_H
21#define BIND9_GETADDRESSES_H 1
22
23/*! \file bind9/getaddresses.h */
24
25#include <isc/lang.h>
26#include <isc/types.h>
27
28#include <isc/net.h>
29
30ISC_LANG_BEGINDECLS
31
32isc_result_t
33bind9_getaddresses(const char *hostname, in_port_t port,
34		   isc_sockaddr_t *addrs, int addrsize, int *addrcount);
35/*%<
36 * Use the system resolver to get the addresses associated with a hostname.
37 * If successful, the number of addresses found is returned in 'addrcount'.
38 * If a hostname lookup is performed and addresses of an unknown family is
39 * seen, it is ignored.  If more than 'addrsize' addresses are seen, the
40 * first 'addrsize' are returned and the remainder silently truncated.
41 *
42 * This routine may block.  If called by a program using the isc_app
43 * framework, it should be surrounded by isc_app_block()/isc_app_unblock().
44 *
45 *  Requires:
46 *\li	'hostname' is not NULL.
47 *\li	'addrs' is not NULL.
48 *\li	'addrsize' > 0
49 *\li	'addrcount' is not NULL.
50 *
51 *
52 * Returns:
53 *\li	#ISC_R_SUCCESS
54 *\li	#ISC_R_NOTFOUND
55 *\li	#ISC_R_NOFAMILYSUPPORT - 'hostname' is an IPv6 address, and IPv6 is
56 *		not supported.
57 */
58
59ISC_LANG_ENDDECLS
60
61#endif /* BIND9_GETADDRESSES_H */
62