1libcurl(3) libcurl easy interface libcurl(3)
2
3
4
6 libcurl-easy - easy interface overview
7
9 When using libcurl's "easy" interface you init your session and get a
10 handle (often referred to as an "easy handle"), which you use as input
11 to the easy interface functions you use. Use curl_easy_init(3) to get
12 the handle.
13
14 You continue by setting all the options you want in the upcoming trans‐
15 fer, the most important among them is the URL itself (you cannot trans‐
16 fer anything without a specified URL as you may have figured out your‐
17 self). You might want to set some callbacks as well that will be called
18 from the library when data is available etc. curl_easy_setopt(3) is
19 used for all this.
20
21 CURLOPT_URL(3) is the only option you really must set, as otherwise
22 there can be no transfer. Another commonly used option is CURLOPT_VER‐
23 BOSE(3) that will help you see what libcurl is doing under the hood,
24 which is useful when debugging for example. The curl_easy_setopt(3) man
25 page has a full index of the almost 300 available options.
26
27 If you at any point would like to blank all previously set options for
28 a single easy handle, you can call curl_easy_reset(3) and you can also
29 make a clone of an easy handle (with all its set options) using
30 curl_easy_duphandle(3).
31
32 When all is setup, you tell libcurl to perform the transfer using
33 curl_easy_perform(3). It will then do the entire operation and will
34 not return until it is done (successfully or not).
35
36 After the transfer has been made, you can set new options and make an‐
37 other transfer, or if you are done, cleanup the session by calling
38 curl_easy_cleanup(3). If you want persistent connections, you do not
39 cleanup immediately, but instead run ahead and perform other transfers
40 using the same easy handle.
41
43 curl_easy_init(3),curl_easy_cleanup(3),curl_easy_setopt(3), libcurl-er‐
44 rors(3), libcurl-multi(3), libcurl(3)
45
46
47
48libcurl 7.82.0 November 08, 2021 libcurl(3)