docs/libcurl/libcurl.3

   1 .\"
   2 .TH libcurl 3 "19 March 2002" "libcurl 7.9.6" "libcurl overview"
   3 .SH NAME
   4 libcurl \- client-side URL transfers
   5 .SH DESCRIPTION
   6 This is a short overview on how to use libcurl in your C programs. There are
   7 specific man pages for each function mentioned in here. There are also the
   8 \fIlibcurl-easy(3)\fP man page, the \fIlibcurl-multi(3)\fP man page, the
   9 \fIlibcurl-share(3)\fP man page and the \fIlibcurl-tutorial(3)\fP man page for
  10 in-depth understanding on how to program with libcurl.
  11
  12 There are more than thirty custom bindings available that bring libcurl access
  13 to your favourite language. Look elsewhere for documentation on those.
  14
  15 libcurl has a global constant environment that you must set up and
  16 maintain while using libcurl.  This essentially means you call
  17 \fIcurl_global_init(3)\fP at the start of your program and
  18 \fIcurl_global_cleanup(3)\fP at the end.  See GLOBAL CONSTANTS below
  19 for details.
  20
  21 To transfer files, you always set up an "easy handle" using
  22 \fIcurl_easy_init(3)\fP, but when you want the file(s) transferred you have
  23 the option of using the "easy" interface, or the "multi" interface.
  24
  25 The easy interface is a synchronous interface with which you call
  26 \fIcurl_easy_perform(3)\fP and let it perform the transfer. When it is
  27 completed, the function returns and you can continue. More details are found in
  28 the \fIlibcurl-easy(3)\fP man page.
  29
  30 The multi interface on the other hand is an asynchronous interface, that you
  31 call and that performs only a little piece of the transfer on each invoke. It
  32 is perfect if you want to do things while the transfer is in progress, or
  33 similar. The multi interface allows you to select() on libcurl action, and
  34 even to easily download multiple files simultaneously using a single thread. See further details in the \fIlibcurl-multi(3)\fP man page.
  35
  36 You can have multiple easy handles share certain data, even if they are used
  37 in different threads. This magic is setup using the share interface, as
  38 described in the \fIlibcurl-share(3)\fP man page.
  39
  40 There is also a series of other helpful functions to use, including these:
  41 .RS
  42 .IP curl_version_info()
  43 gets detailed libcurl (and other used libraries) version info
  44 .IP curl_getdate()
  45 converts a date string to time_t
  46 .IP curl_easy_getinfo()
  47 get information about a performed transfer
  48 .IP curl_formadd()
  49 helps building an HTTP form POST
  50 .IP curl_formfree()
  51 free a list built with \fIcurl_formadd(3)\fP
  52 .IP curl_slist_append()
  53 builds a linked list
  54 .IP curl_slist_free_all()
  55 frees a whole curl_slist
  56 .RE
  57
  58 .SH "LINKING WITH LIBCURL"
  59 On unix-like machines, there's a tool named curl-config that gets installed
  60 with the rest of the curl stuff when 'make install' is performed.
  61
  62 curl-config is added to make it easier for applications to link with libcurl
  63 and developers to learn about libcurl and how to use it.
  64
  65 Run 'curl-config --libs' to get the (additional) linker options you need to
  66 link with the particular version of libcurl you've installed. See the
  67 \fIcurl-config(1)\fP man page for further details.
  68
  69 Unix-like operating system that ship libcurl as part of their distributions
  70 often don't provide the curl-config tool, but simply install the library and
  71 headers in the common path for this purpose.
  72
  73 .SH "LIBCURL SYMBOL NAMES"
  74 All public functions in the libcurl interface are prefixed with 'curl_' (with
  75 a lowercase c). You can find other functions in the library source code, but
  76 other prefixes indicate that the functions are private and may change without
  77 further notice in the next release.
  78
  79 Only use documented functions and functionality!
  80 .SH "PORTABILITY"
  81 libcurl works
  82 .B exactly
  83 the same, on any of the platforms it compiles and builds on.
  84 .SH "THREADS"
  85 Never ever call curl-functions simultaneously using the same handle from
  86 several threads. libcurl is thread-safe and can be used in any number of
  87 threads, but you must use separate curl handles if you want to use libcurl in
  88 more than one thread simultaneously.
  89
  90 The global environment functions are not thread-safe.  See GLOBAL CONSTANTS
  91 below for details.
  92
  93 .SH "PERSISTENT CONNECTIONS"
  94 Persistent connections means that libcurl can re-use the same connection for
  95 several transfers, if the conditions are right.
  96
  97 libcurl will \fBalways\fP attempt to use persistent connections. Whenever you
  98 use \fIcurl_easy_perform(3)\fP or \fIcurl_multi_perform(3)\fP, libcurl will
  99 attempt to use an existing connection to do the transfer, and if none exists
 100 it'll open a new one that will be subject for re-use on a possible following
 101 call to \fIcurl_easy_perform(3)\fP or \fIcurl_multi_perform(3)\fP.
 102
 103 To allow libcurl to take full advantage of persistent connections, you should
 104 do as many of your file transfers as possible using the same curl handle. When
 105 you call \fIcurl_easy_cleanup(3)\fP, all the possibly open connections held by
 106 libcurl will be closed and forgotten.
 107
 108 Note that the options set with \fIcurl_easy_setopt(3)\fP will be used on
 109 every repeated \fIcurl_easy_perform(3)\fP call.
 110
 111 .SH "GLOBAL CONSTANTS"
 112 There are a variety of constants that libcurl uses, mainly through its
 113 internal use of other libraries, which are too complicated for the
 114 library loader to set up.  Therefore, a program must call a library
 115 function after the program is loaded and running to finish setting up
 116 the library code.  For example, when libcurl is built for SSL
 117 capability via the GNU TLS library, there is an elaborate tree inside
 118 that library that describes the SSL protocol.
 119
 120 \fIcurl_global_init()\fP is the function that you must call.  This may
 121 allocate resources (e.g. the memory for the GNU TLS tree mentioned
 122 above), so the companion function \fIcurl_global_cleanup()\fP releases
 123 them.
 124
 125 The basic rule for constructing a program that uses libcurl is this:
 126 Call \fIcurl_global_init()\fP, with a \fICURL_GLOBAL_ALL\fP argument,
 127 immediately after the program starts, while it is still only one
 128 thread and before it uses libcurl at all.  Call
 129 \fIcurl_global_cleanup()\fP immediately before the program exits, when
 130 the program is again only one thread and after its last use of
 131 libcurl.
 132
 133 You can call both of these multiple times, as long as all calls meet
 134 these requirements and the number of calls to each is the same.
 135
 136 It isn't actually required that the functions be called at the beginning
 137 and end of the program -- that's just usually the easiest way to do it.
 138 It \fIis\fP required that the functions be called when no other thread
 139 in the program is running.
 140
 141 These global constant functions are \fInot thread safe\fP, so you must
 142 not call them when any other thread in the program is running.  It
 143 isn't good enough that no other thread is using libcurl at the time,
 144 because these functions internally call similar functions of other
 145 libraries, and those functions are similarly thread-unsafe.  You can't
 146 generally know what these libraries are, or whether other threads are
 147 using them.
 148
 149 The global constant situation merits special consideration when the
 150 code you are writing to use libcurl is not the main program, but rather
 151 a modular piece of a program, e.g. another library.  As a module,
 152 your code doesn't know about other parts of the program -- it doesn't
 153 know whether they use libcurl or not.  And its code doesn't necessarily
 154 run at the start and end of the whole program.
 155
 156 A module like this must have global constant functions of its own,
 157 just like \fIcurl_global_init()\fP and \fIcurl_global_cleanup()\fP.
 158 The module thus has control at the beginning and end of the program
 159 and has a place to call the libcurl functions.  Note that if multiple
 160 modules in the program use libcurl, they all will separately call the
 161 libcurl functions, and that's OK because only the first
 162 \fIcurl_global_init()\fP and the last \fIcurl_global_cleanup()\fP in a
 163 program change anything.  (libcurl uses a reference count in static
 164 memory).
 165
 166 In a C++ module, it is common to deal with the global constant
 167 situation by defining a special class that represents the global
 168 constant environment of the module.  A program always has exactly one
 169 object of the class, in static storage.  That way, the program
 170 automatically calls the constructor of the object as the program
 171 starts up and the destructor as it terminates.  As the author of this
 172 libcurl-using module, you can make the constructor call
 173 \fIcurl_global_init()\fP and the destructor call
 174 \fIcurl_global_cleanup()\fP and satisfy libcurl's requirements without
 175 your user having to think about it.
 176
 177 \fIcurl_global_init()\fP has an argument that tells what particular
 178 parts of the global constant environment to set up.  In order to
 179 successfully use any value except \fICURL_GLOBAL_ALL\fP (which says to
 180 set up the whole thing), you must have specific knowledge of internal
 181 workings of libcurl and all other parts of the program of which it is
 182 part.
 183
 184 A special part of the global constant environment is the identity of
 185 the memory allocator.  \fIcurl_global_init()\fP selects the system
 186 default memory allocator, but you can use \fIcurl_global_init_mem()\fP
 187 to supply one of your own.  However, there is no way to use
 188 \fIcurl_global_init_mem()\fP in a modular program -- all modules in
 189 the program that might use libcurl would have to agree on one
 190 allocator.
 191
 192 There is a failsafe in libcurl that makes it usable in simple
 193 situations without you having to worry about the global constant
 194 environment at all: \fIcurl_easy_init()\fP sets up the environment
 195 itself if it hasn't been done yet.  The resources it acquires to do so
 196 get released by the operating system automatically when the program
 197 exits.
 198
 199 This failsafe feature exists mainly for backward compatibility because
 200 there was a time when the global functions didn't exist.  Because it
 201 is sufficient only in the simplest of programs, it is not recommended
 202 for any program to rely on it.