libcurl-easy.3 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. .\" generated by cd2nroff 0.1 from libcurl-easy.md
  2. .TH libcurl-easy 3 "2025-01-17" libcurl
  3. .SH NAME
  4. libcurl\-easy \- easy interface overview
  5. .SH DESCRIPTION
  6. When using libcurl\(aqs "easy" interface you init your session and get a handle
  7. (often referred to as an "easy handle"), which you use as input to the easy
  8. interface functions you use. Use \fIcurl_easy_init(3)\fP to get the handle.
  9. You continue by setting all the options you want in the upcoming transfer, the
  10. most important among them is the URL itself (you cannot transfer anything
  11. without a specified URL). You might want to set some callbacks as well that
  12. are called from the library when data is available etc. For example
  13. \fICURLOPT_WRITEFUNCTION(3)\fP. \fIcurl_easy_setopt(3)\fP is used for all this.
  14. \fICURLOPT_URL(3)\fP is the only option you really must set, as otherwise there can
  15. be no transfer. Another commonly used option is \fICURLOPT_VERBOSE(3)\fP that helps
  16. you see what libcurl is doing under the hood, which is useful when debugging
  17. for example. The \fIcurl_easy_setopt(3)\fP man page has a full index of the over 300
  18. available options.
  19. If you at any point would like to blank all previously set options for a
  20. single easy handle, you can call \fIcurl_easy_reset(3)\fP and you can also make a
  21. clone of an easy handle (with all its set options) using
  22. \fIcurl_easy_duphandle(3)\fP.
  23. When all is setup, you tell libcurl to perform the transfer using
  24. \fIcurl_easy_perform(3)\fP. It performs the entire transfer operation and does not
  25. return until it is done (successfully or not).
  26. After the transfer has been made, you can set new options and make another
  27. transfer, or if you are done, cleanup the session by calling
  28. \fIcurl_easy_cleanup(3)\fP. If you want persistent connections, you do not cleanup
  29. immediately, but instead run ahead and perform other transfers using the same
  30. easy handle.
  31. .SH SEE ALSO
  32. .BR curl_easy_cleanup (3),
  33. .BR curl_easy_init (3),
  34. .BR curl_easy_setopt (3),
  35. .BR libcurl (3),
  36. .BR libcurl-errors (3),
  37. .BR libcurl-multi (3)