contrib/bind9/lib/dns/include/dns/lib.h

   1 /*
   2  * Copyright (C) 2004-2007, 2009  Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (C) 1999-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: lib.h,v 1.18 2009/09/02 23:48:02 tbox Exp $ */
  19
  20 #ifndef DNS_LIB_H
  21 #define DNS_LIB_H 1
  22
  23 /*! \file dns/lib.h */
  24
  25 #include <isc/types.h>
  26 #include <isc/lang.h>
  27
  28 ISC_LANG_BEGINDECLS
  29
  30 /*%
  31  * Tuning: external query load in packets per seconds.
  32  */
  33 LIBDNS_EXTERNAL_DATA extern unsigned int dns_pps;
  34 LIBDNS_EXTERNAL_DATA extern isc_msgcat_t *dns_msgcat;
  35
  36 void
  37 dns_lib_initmsgcat(void);
  38 /*%<
  39  * Initialize the DNS library's message catalog, dns_msgcat, if it
  40  * has not already been initialized.
  41  */
  42
  43 isc_result_t
  44 dns_lib_init(void);
  45 /*%<
  46  * A set of initialization procedure used in the DNS library.  This function
  47  * is provided for an application that is not aware of the underlying ISC or
  48  * DNS libraries much.
  49  */
  50
  51 void
  52 dns_lib_shutdown(void);
  53 /*%<
  54  * Free temporary resources allocated in dns_lib_init().
  55  */
  56
  57 ISC_LANG_ENDDECLS
  58
  59 #endif /* DNS_LIB_H */