ares_library_init.3

   1 .\"
   2 .\" Copyright 1998 by the Massachusetts Institute of Technology.
   3 .\" Copyright (C) 2004-2009 by Daniel Stenberg
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this
   6 .\" software and its documentation for any purpose and without
   7 .\" fee is hereby granted, provided that the above copyright
   8 .\" notice appear in all copies and that both that copyright
   9 .\" notice and this permission notice appear in supporting
  10 .\" documentation, and that the name of M.I.T. not be used in
  11 .\" advertising or publicity pertaining to distribution of the
  12 .\" software without specific, written prior permission.
  13 .\" M.I.T. makes no representations about the suitability of
  14 .\" this software for any purpose.  It is provided "as is"
  15 .\" without express or implied warranty.
  16 .\"
  17 .TH ARES_LIBRARY_INIT 3 "19 May 2009"
  18 .SH NAME
  19 ares_library_init \- c-ares library initialization
  20 .SH SYNOPSIS
  21 .nf
  22 #include <ares.h>
  23
  24 int ares_library_init(int \fIflags\fP)
  25
  26 int ares_library_init_mem(int \fIflags\fP,
  27                           void *(*\fIamalloc\fP)(size_t),
  28                           void (*\fIafree\fP)(void *ptr),
  29                           void (*\fIarealloc\fP)(void *ptr, size_t size))
  30 .fi
  31 .SH DESCRIPTION
  32 .PP
  33 The
  34 .B ares_library_init
  35 function performs initializations internally required by the c-ares
  36 library that must take place before any other function provided by
  37 c-ares can be used in a program.
  38 .PP
  39 This function must be called at least once within the life of a program,
  40 before the program actually executes any other c-ares library function.
  41 Initializations done by this function remain effective until a number of
  42 calls to \fIares_library_cleanup(3)\fP equal to the number of calls to
  43 this function are performed.
  44 .PP
  45 Successive calls to this function do nothing further, only the first
  46 call done when c-ares is in an uninitialized state is actually
  47 effective.
  48 .PP
  49 The
  50 .I flags
  51 parameter is a bit pattern that tells c-ares exactly which features
  52 should be initialized, as described below. Set the desired bits by
  53 ORing the values together. In normal operation you should specify
  54 \fIARES_LIB_INIT_ALL\fP. Don't use any other value unless you are
  55 familiar with it and trying to control some internal c-ares feature.
  56 .PP
  57 The
  58 .B ares_library_init_mem
  59 function allows the caller to provide memory management functions that the
  60 c-ares library will be use instead of \fImalloc(3)\fP, \fIfree(3)\fP and
  61 \fIrealloc(3)\fP.
  62 .PP
  63 .B This function is not thread safe.
  64 You have to call it once the program has started, but this call must be done
  65 before the program starts any other thread. This is required to avoid
  66 potential race conditions in library initialization, and also due to the fact
  67 that \fIares_library_init(3)\fP might call functions from other libraries that
  68 are thread unsafe, and could conflict with any other thread that is already
  69 using these other libraries.
  70 .PP
  71 Win32/64 application DLLs shall not call \fIares_library_init(3)\fP from the
  72 DllMain function. Doing so will produce deadlocks and other problems.
  73 .SH FLAGS
  74 .TP 5
  75 .B ARES_LIB_INIT_ALL
  76 Initialize everything possible. This sets all known bits.
  77 .TP
  78 .B ARES_LIB_INIT_WIN32
  79 Initialize Win32/64 specific libraries.
  80 .TP
  81 .B ARES_LIB_INIT_NONE
  82 Initialize nothing extra. This sets no bit.
  83 .SH RETURN VALUE
  84 Upon successful completion, ares_library_init() will return 0.  Otherwise, a
  85 non-zero error number will be returned to indicate the error. Except for
  86 \fIares_strerror(3)\fP, you shall not call any other c-ares function upon
  87 \fIares_library_init(3)\fP failure.
  88 .SH AVAILABILITY
  89 This function was first introduced in c-ares version 1.7.0 along with the
  90 definition of preprocessor symbol \fICARES_HAVE_ARES_LIBRARY_INIT\fP as an
  91 indication of the availability of this function. Its recursive behavior,
  92 which requires a matching number of calls to \fIares_library_cleanup()\fP
  93 in order to deinitialize the library, is present since c-ares version
  94 1.10.0. Earlier versions would deinitialize the library on the first call
  95 to \fIares_library_cleanup()\fP.
  96 .PP
  97 Since the introduction of this function it is absolutely mandatory to
  98 call it for any Win32/64 program using c-ares.
  99 .PP
 100 Non-Win32/64 systems can still use c-ares version 1.7.0 without calling
 101 \fIares_library_init(3)\fP due to the fact that \fIcurrently\fP it is nearly
 102 a do-nothing function on non-Win32/64 platforms at this point.
 103 .SH SEE ALSO
 104 .BR ares_library_cleanup(3),
 105 .BR ares_strerror(3)
 106 .SH AUTHOR
 107 Yang Tse
 108 .PP
 109 Copyright 1998 by the Massachusetts Institute of Technology.
 110 .br
 111 Copyright (C) 2004-2009 by Daniel Stenberg.