Artifactspublic-v0

curl

master
ply4 git calls161 ms291 KiB2 cachedprotocol v2
250 lines10 KiBRaw

NAME

libcurl - client-side URL transfers

DESCRIPTION

This is a short overview on how to use libcurl in your C programs. There are specific man pages for each function mentioned in here. See libcurl-easy(3), libcurl-multi(3), libcurl-share(3), libcurl-url(3), libcurl-ws(3) and libcurl-tutorial(3) for in-depth understanding on how to program with libcurl.

There are many bindings available that bring libcurl access to your favorite language. Look elsewhere for documentation on those.

TRANSFERS

To transfer files, you create an "easy handle" using curl_easy_init(3) for a single individual transfer (in either direction). You then set your desired set of options in that handle with curl_easy_setopt(3). Options you set with curl_easy_setopt(3) stick. They are then used for every repeated use of this handle until you either change the option, or you reset them all with curl_easy_reset(3).

To actually transfer data you have the option of using the "easy" interface, or the "multi" interface.

The easy interface is a synchronous interface with which you call curl_easy_perform(3) and let it perform the transfer. When it is completed, the function returns and you can continue. More details are found in the libcurl-easy(3) man page.

The multi interface on the other hand is an asynchronous interface, that you call and that performs only a little piece of the transfer on each invoke. It is perfect if you want to do things while the transfer is in progress, or similar. The multi interface allows you to select() on libcurl action, and even to easily download multiple files simultaneously using a single thread. See further details in the libcurl-multi(3) man page.

SUPPORT INTERFACES

There is also a series of other helpful functions and interface families to use, including these:

curl_version_info()

gets detailed libcurl (and other used libraries) version info. See curl_version_info(3)

curl_getdate()

converts a date string to time_t. See curl_getdate(3)

curl_easy_getinfo()

get information about a performed transfer. See curl_easy_getinfo(3)

curl_mime_addpart()

helps building an HTTP form POST. See curl_mime_addpart(3)

curl_slist_append()

builds a linked list. See curl_slist_append(3)

Sharing data between transfers

You can have multiple easy handles share certain data, even if they are used in different threads. Set that up using the share interface, as described in the libcurl-share(3) man page.

URL Parsing

URL parsing and manipulations. See libcurl-url(3)

WebSocket communication

See libcurl-ws(3)

LINKING WITH LIBCURL

On Unix-like machines, there is a tool named curl-config that gets installed with the rest of the curl stuff when 'make install' is performed.

curl-config is added to make it easier for applications to link with libcurl and developers to learn about libcurl and how to use it.

Run 'curl-config --libs' to get the (additional) linker options you need to link with the particular version of libcurl you have installed. See the curl-config(1) man page for further details.

Unix-like operating system that ship libcurl as part of their distributions often do not provide the curl-config tool, but only install the library and headers in the common path for this purpose.

Many Linux and similar systems use pkg-config to provide build and link options about libraries and libcurl supports that as well.

LIBCURL SYMBOL NAMES

All public functions in the libcurl interface are prefixed with 'curl_' (with a lowercase c). You can find other functions in the library source code, but other prefixes indicate that the functions are private and may change without further notice in the next release.

Only use documented functions and functionality.

PORTABILITY

libcurl works exactly the same, on any of the platforms it compiles and builds on.

THREADS

libcurl is thread-safe but there are a few exceptions. Refer to libcurl-thread(3) for more information.

PERSISTENT CONNECTIONS

Persistent connections means that libcurl can reuse the same connection for several transfers, if the conditions are right.

libcurl always attempts to use persistent connections. Whenever you use curl_easy_perform(3) or curl_multi_perform(3) etc, libcurl attempts to use an existing connection to do the transfer, and if none exists it opens a new one that is subject for reuse on a possible following call to curl_easy_perform(3) or curl_multi_perform(3).

To allow libcurl to take full advantage of persistent connections, you should do as many of your file transfers as possible using the same handle.

If you use the easy interface, and you call curl_easy_cleanup(3), all the possibly open connections held by libcurl are closed and forgotten.

When you have created a multi handle and are using the multi interface, the connection pool is instead kept in the multi handle so closing and creating new easy handles to do transfers do not affect them. Instead all added easy handles can take advantage of the single shared pool.

GLOBAL CONSTANTS

There are a variety of constants that libcurl uses, mainly through its internal use of other libraries, which are too complicated for the library loader to set up. Therefore, a program must call a library function after the program is loaded and running to finish setting up the library code. For example, when libcurl is built for SSL capability via the GNU TLS library, there is an elaborate tree inside that library that describes the SSL protocol.

curl_global_init(3) is the function that you must call. This may allocate resources (e.g. the memory for the GNU TLS tree mentioned above), so the companion function curl_global_cleanup(3) releases them.

If libcurl was compiled with support for multiple SSL backends, the function curl_global_sslset(3) can be called before curl_global_init(3) to select the active SSL backend.

The global constant functions are thread-safe since libcurl 7.84.0 if curl_version_info(3) has the CURL_VERSION_THREADSAFE feature bit set (most platforms). Read libcurl-thread(3) for thread-safety guidelines.

If the global constant functions are not thread-safe, then you must not call them when any other thread in the program is running. It is not good enough that no other thread is using libcurl at the time, because these functions internally call similar functions of other libraries, and those functions are similarly thread-unsafe. You cannot generally know what these libraries are, or whether other threads are using them.

If the global constant functions are not thread-safe, then the basic rule for constructing a program that uses libcurl is this: Call curl_global_init(3), with a CURL_GLOBAL_ALL argument, immediately after the program starts, while it is still only one thread and before it uses libcurl at all. Call curl_global_cleanup(3) immediately before the program exits, when the program is again only one thread and after its last use of libcurl.

It is not actually required that the functions be called at the beginning and end of the program -- that is usually the easiest way to do it.

You can call both of these multiple times, as long as all calls meet these requirements and the number of calls to each is the same.

The global constant situation merits special consideration when the code you are writing to use libcurl is not the main program, but rather a modular piece of a program, e.g. another library. As a module, your code does not know about other parts of the program -- it does not know whether they use libcurl or not. Its code does not necessarily run at the start and end of the whole program.

A module like this must have global constant functions of its own, like curl_global_init(3) and curl_global_cleanup(3). The module thus has control at the beginning and end of the program and has a place to call the libcurl functions. If multiple modules in the program use libcurl, they all separately call the libcurl functions, and that is OK because only the first curl_global_init(3) and the last curl_global_cleanup(3) in a program change anything. (libcurl uses a reference count in static memory).

In a C++ module, it is common to deal with the global constant situation by defining a special class that represents the global constant environment of the module. A program always has exactly one object of the class, in static storage. That way, the program automatically calls the constructor of the object as the program starts up and the destructor as it terminates. As the author of this libcurl-using module, you can make the constructor call curl_global_init(3) and the destructor call curl_global_cleanup(3) and satisfy libcurl's requirements without your user having to think about it. (Caveat: If you are initializing libcurl from a Windows DLL you should not initialize it from DllMain or a static initializer because Windows holds the loader lock during that time and it could cause a deadlock.)

curl_global_init(3) has an argument that tells what particular parts of the global constant environment to set up. In order to successfully use any value except CURL_GLOBAL_ALL (which says to set up the whole thing), you must have specific knowledge of internal workings of libcurl and all other parts of the program of which it is part.

A special part of the global constant environment is the identity of the memory allocator. curl_global_init(3) selects the system default memory allocator, but you can use curl_global_init_mem(3) to supply one of your own. There is no way to use curl_global_init_mem(3) in a modular program -- all modules in the program that might use libcurl would have to agree on one allocator.

There is a failsafe in libcurl that makes it usable in simple situations without you having to worry about the global constant environment at all: curl_easy_init(3) sets up the environment itself if it has not been done yet. The resources it acquires to do so get released by the operating system automatically when the program exits.

This failsafe feature exists mainly for backward compatibility because there was a time when the global functions did not exist. Because it is sufficient only in the simplest of programs, it is not recommended for any program to rely on it.

1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: libcurl
5Section: 3
6Source: libcurl
7See-also:
8 - libcurl-easy (3)
9 - libcurl-multi (3)
10 - libcurl-security (3)
11 - libcurl-thread (3)
12Protocol:
13 - All
14Added-in: n/a
15---
17# NAME
19libcurl - client-side URL transfers
21# DESCRIPTION
23This is a short overview on how to use libcurl in your C programs. There are
24specific man pages for each function mentioned in here. See
25libcurl-easy(3), libcurl-multi(3), libcurl-share(3),
26libcurl-url(3), libcurl-ws(3) and libcurl-tutorial(3) for
27in-depth understanding on how to program with libcurl.
29There are many bindings available that bring libcurl access to your favorite
30language. Look elsewhere for documentation on those.
32# TRANSFERS
34To transfer files, you create an "easy handle" using curl_easy_init(3)
35for a single individual transfer (in either direction). You then set your
36desired set of options in that handle with curl_easy_setopt(3). Options
37you set with curl_easy_setopt(3) stick. They are then used for every
38repeated use of this handle until you either change the option, or you reset
39them all with curl_easy_reset(3).
41To actually transfer data you have the option of using the "easy" interface,
42or the "multi" interface.
44The easy interface is a synchronous interface with which you call
45curl_easy_perform(3) and let it perform the transfer. When it is
46completed, the function returns and you can continue. More details are found in
47the libcurl-easy(3) man page.
49The multi interface on the other hand is an asynchronous interface, that you
50call and that performs only a little piece of the transfer on each invoke. It
51is perfect if you want to do things while the transfer is in progress, or
52similar. The multi interface allows you to select() on libcurl action, and
53even to easily download multiple files simultaneously using a single
54thread. See further details in the libcurl-multi(3) man page.
56# SUPPORT INTERFACES
58There is also a series of other helpful functions and interface families to
59use, including these:
61## curl_version_info()
63gets detailed libcurl (and other used libraries) version info. See
64curl_version_info(3)
66## curl_getdate()
68converts a date string to time_t. See curl_getdate(3)
70## curl_easy_getinfo()
72get information about a performed transfer. See curl_easy_getinfo(3)
74## curl_mime_addpart()
76helps building an HTTP form POST. See curl_mime_addpart(3)
78## curl_slist_append()
80builds a linked list. See curl_slist_append(3)
82## Sharing data between transfers
84You can have multiple easy handles share certain data, even if they are used
85in different threads. Set that up using the share interface, as described in
86the libcurl-share(3) man page.
88## URL Parsing
90URL parsing and manipulations. See libcurl-url(3)
92## WebSocket communication
94See libcurl-ws(3)
96# LINKING WITH LIBCURL
98On Unix-like machines, there is a tool named curl-config that gets installed
99with the rest of the curl stuff when 'make install' is performed.
101curl-config is added to make it easier for applications to link with libcurl
102and developers to learn about libcurl and how to use it.
104Run 'curl-config --libs' to get the (additional) linker options you need to
105link with the particular version of libcurl you have installed. See the
106*curl-config(1)* man page for further details.
108Unix-like operating system that ship libcurl as part of their distributions
109often do not provide the curl-config tool, but only install the library and
110headers in the common path for this purpose.
112Many Linux and similar systems use pkg-config to provide build and link
113options about libraries and libcurl supports that as well.
115# LIBCURL SYMBOL NAMES
117All public functions in the libcurl interface are prefixed with 'curl_' (with
118a lowercase c). You can find other functions in the library source code, but
119other prefixes indicate that the functions are private and may change without
120further notice in the next release.
122Only use documented functions and functionality.
124# PORTABILITY
126libcurl works
127**exactly**
128the same, on any of the platforms it compiles and builds on.
130# THREADS
132libcurl is thread-safe but there are a few exceptions. Refer to
133libcurl-thread(3) for more information.
135# PERSISTENT CONNECTIONS
137Persistent connections means that libcurl can reuse the same connection for
138several transfers, if the conditions are right.
140libcurl always attempts to use persistent connections. Whenever you use
141curl_easy_perform(3) or curl_multi_perform(3) etc, libcurl
142attempts to use an existing connection to do the transfer, and if none exists
143it opens a new one that is subject for reuse on a possible following call to
144curl_easy_perform(3) or curl_multi_perform(3).
146To allow libcurl to take full advantage of persistent connections, you should
147do as many of your file transfers as possible using the same handle.
149If you use the easy interface, and you call curl_easy_cleanup(3), all
150the possibly open connections held by libcurl are closed and forgotten.
152When you have created a multi handle and are using the multi interface, the
153connection pool is instead kept in the multi handle so closing and creating
154new easy handles to do transfers do not affect them. Instead all added easy
155handles can take advantage of the single shared pool.
157# GLOBAL CONSTANTS
159There are a variety of constants that libcurl uses, mainly through its
160internal use of other libraries, which are too complicated for the
161library loader to set up. Therefore, a program must call a library
162function after the program is loaded and running to finish setting up
163the library code. For example, when libcurl is built for SSL
164capability via the GNU TLS library, there is an elaborate tree inside
165that library that describes the SSL protocol.
167curl_global_init(3) is the function that you must call. This may
168allocate resources (e.g. the memory for the GNU TLS tree mentioned above), so
169the companion function curl_global_cleanup(3) releases them.
171If libcurl was compiled with support for multiple SSL backends, the function
172curl_global_sslset(3) can be called before curl_global_init(3)
173to select the active SSL backend.
175The global constant functions are thread-safe since libcurl 7.84.0 if
176curl_version_info(3) has the CURL_VERSION_THREADSAFE feature bit set
177(most platforms). Read libcurl-thread(3) for thread-safety guidelines.
179If the global constant functions are *not thread-safe*, then you must
180not call them when any other thread in the program is running. It
181is not good enough that no other thread is using libcurl at the time,
182because these functions internally call similar functions of other
183libraries, and those functions are similarly thread-unsafe. You cannot
184generally know what these libraries are, or whether other threads are
185using them.
187If the global constant functions are *not thread-safe*, then the basic rule
188for constructing a program that uses libcurl is this: Call
189curl_global_init(3), with a *CURL_GLOBAL_ALL* argument, immediately
190after the program starts, while it is still only one thread and before it uses
191libcurl at all. Call curl_global_cleanup(3) immediately before the
192program exits, when the program is again only one thread and after its last
193use of libcurl.
195It is not actually required that the functions be called at the beginning and
196end of the program -- that is usually the easiest way to do it.
198You can call both of these multiple times, as long as all calls meet
199these requirements and the number of calls to each is the same.
201The global constant situation merits special consideration when the code you
202are writing to use libcurl is not the main program, but rather a modular piece
203of a program, e.g. another library. As a module, your code does not know about
204other parts of the program -- it does not know whether they use libcurl or
205not. Its code does not necessarily run at the start and end of the whole
206program.
208A module like this must have global constant functions of its own, like
209curl_global_init(3) and curl_global_cleanup(3). The module thus has control at
210the beginning and end of the program and has a place to call the libcurl
211functions. If multiple modules in the program use libcurl, they all separately
212call the libcurl functions, and that is OK because only the first
213curl_global_init(3) and the last curl_global_cleanup(3) in a program change
214anything. (libcurl uses a reference count in static memory).
216In a C++ module, it is common to deal with the global constant situation by
217defining a special class that represents the global constant environment of
218the module. A program always has exactly one object of the class, in static
219storage. That way, the program automatically calls the constructor of the
220object as the program starts up and the destructor as it terminates. As the
221author of this libcurl-using module, you can make the constructor call
222curl_global_init(3) and the destructor call curl_global_cleanup(3)
223and satisfy libcurl's requirements without your user having to think about it.
224(Caveat: If you are initializing libcurl from a Windows DLL you should not
225initialize it from *DllMain* or a static initializer because Windows holds
226the loader lock during that time and it could cause a deadlock.)
228curl_global_init(3) has an argument that tells what particular parts of
229the global constant environment to set up. In order to successfully use any
230value except *CURL_GLOBAL_ALL* (which says to set up the whole thing), you
231must have specific knowledge of internal workings of libcurl and all other
232parts of the program of which it is part.
234A special part of the global constant environment is the identity of the
235memory allocator. curl_global_init(3) selects the system default memory
236allocator, but you can use curl_global_init_mem(3) to supply one of your own.
237There is no way to use curl_global_init_mem(3) in a modular program -- all
238modules in the program that might use libcurl would have to agree on one
239allocator.
241There is a failsafe in libcurl that makes it usable in simple situations
242without you having to worry about the global constant environment at all:
243curl_easy_init(3) sets up the environment itself if it has not been done
244yet. The resources it acquires to do so get released by the operating system
245automatically when the program exits.
247This failsafe feature exists mainly for backward compatibility because there
248was a time when the global functions did not exist. Because it is sufficient
249only in the simplest of programs, it is not recommended for any program to
250rely on it.
Diagnostics4 git calls · 161 ms
CallStatusSizeTime0161 ms
discover200152 B3 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=3
git.response.bytes=152
git.server.agent=gitty/1.0
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch object-format
git.server.fetch=shallow filter sideband-all
git.protocol.version=2
git.pkt.frames=8
git.pkt.data=6
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=152
git.pkt.payload.max=34
ls-refs200149 B · hit3 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=3
git.response.bytes=149
git.response.cache=HIT
git.response.duration_ms=3
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=149
git.pkt.payload.max=78
git.ls_refs.count=2
git.ls_refs.head=refs/heads/master
fetchblob:none · deepen 10200287 KiB · hit3 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=155
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=3
git.fetch.filter=blob:none
git.fetch.filter.requested=tree:0
git.fetch.filter.fallback=blob:none
git.fetch.filter.learned=false
git.fetch.wants=31c911efe5652725e930f4d2e60c9060e5f6646d
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=10
git.pkt.data=8
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=293470
git.pkt.payload.max=65516
git.sideband.band1.bytes=293354
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=87
git.pack.bytes=293354
git.pack.ofs_delta=0
git.pack.ref_delta=1
git.pack.chain.max=1
git.pack.trailer=6a646bcda6740bab42e321b51998b52ea15146c0
git.pack.full=86
Open pack map
fetch2004.3 KiB155 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=4453
git.response.cache=MISS
git.response.duration_ms=155
git.fetch.wants=da61d4c5ea511baf17b2f45ec55f56166d0e0019
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=4453
git.pkt.payload.max=4432
git.sideband.band1.bytes=4431
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://5ad2236b39de4c8bd8f6270ea63f3ea9.artifacts.cloudflare.net/git/public-v0/curl.git
Ref
refs/heads/master
Commit
31c911efe5652725e930f4d2e60c9060e5f6646d
cf-ray
a5e3289828784628
Request
92b7f23a…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format