contrib/bind-9.3/lib/bind9/include/bind9/getaddresses.h

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