docs/libcurl/libcurl-easy.3

   1 .\" You can view this file with:
   2 .\" nroff -man [file]
   3 .\" $Id$
   4 .\"
   5 .TH libcurl 3 "12 Aug 2003" "libcurl 7.10.7" "libcurl easy interface"
   6 .SH NAME
   7 libcurl-easy \- easy interface overview
   8 .SH DESCRIPTION
   9 When using libcurl's "easy" interface you init your session and get a handle
  10 (often referred to as an "easy handle" in various docs and sources), which you
  11 use as input to the easy interface functions you use. Use
  12 \fIcurl_easy_init(3)\fP to get the handle.
  13
  14 You continue by setting all the options you want in the upcoming transfer, the
  15 most important among them is the URL itself (you can't transfer anything
  16 without a specified URL as you may have figured out yourself). You might want
  17 to set some callbacks as well that will be called from the library when data
  18 is available etc. \fIcurl_easy_setopt(3)\fP is used for all this.
  19
  20 When all is setup, you tell libcurl to perform the transfer using
  21 \fIcurl_easy_perform(3)\fP.  It will then do the entire operation and won't
  22 return until it is done (successfully or not).
  23
  24 After the transfer has been made, you can set new options and make another
  25 transfer, or if you're done, cleanup the session by calling
  26 \fIcurl_easy_cleanup(3)\fP. If you want persistent connections, you don't
  27 cleanup immediately, but instead run ahead and perform other transfers using
  28 the same easy handle.
  29