2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from libcurl-share.md
|
2024-07-29 18:00:04 -06:00
|
|
|
.TH libcurl-share 3 "2024-07-29" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
libcurl\-share \- how to use the share interface
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
This is an overview on how to use the libcurl share interface in your C
|
|
|
|
|
programs. There are specific man pages for each function mentioned in
|
|
|
|
|
here.
|
|
|
|
|
|
|
|
|
|
All functions in the share interface are prefixed with curl_share.
|
|
|
|
|
.SH OBJECTIVES
|
|
|
|
|
The share interface was added to enable sharing of data between curl handles.
|
|
|
|
|
.SH ONE SET OF DATA - MANY TRANSFERS
|
|
|
|
|
You can have multiple easy handles share data between them. Have them update
|
|
|
|
|
and use the \fBsame\fP cookie database, DNS cache, TLS session cache and/or
|
|
|
|
|
connection cache! This way, each single transfer takes advantage from data
|
|
|
|
|
updates made by the other transfer(s).
|
|
|
|
|
.SH SHARE OBJECT
|
|
|
|
|
You create a shared object with \fIcurl_share_init(3)\fP. It returns a handle
|
|
|
|
|
for a newly created one.
|
|
|
|
|
|
|
|
|
|
You tell the shared object what data you want it to share by using
|
|
|
|
|
\fIcurl_share_setopt(3)\fP.
|
|
|
|
|
|
|
|
|
|
Since you can use this share from multiple threads, and libcurl has no
|
|
|
|
|
internal thread synchronization, you must provide mutex callbacks if you are
|
|
|
|
|
using this multi\-threaded. You set lock and unlock functions with
|
|
|
|
|
\fIcurl_share_setopt(3)\fP too.
|
|
|
|
|
|
|
|
|
|
Then, you make an easy handle to use this share, you set the
|
|
|
|
|
\fICURLOPT_SHARE(3)\fP option with \fIcurl_easy_setopt(3)\fP, and pass in
|
|
|
|
|
share handle. You can make any number of easy handles share the same share
|
|
|
|
|
handle.
|
|
|
|
|
|
|
|
|
|
To make an easy handle stop using that particular share, you set
|
|
|
|
|
\fICURLOPT_SHARE(3)\fP to NULL for that easy handle. To make a handle stop
|
|
|
|
|
sharing a particular data, you can \fICURLSHOPT_UNSHARE(3)\fP it.
|
|
|
|
|
|
|
|
|
|
When you are done using the share, make sure that no easy handle is still using
|
|
|
|
|
it, and call \fIcurl_share_cleanup(3)\fP on the handle.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR curl_share_cleanup (3),
|
|
|
|
|
.BR curl_share_init (3),
|
|
|
|
|
.BR curl_share_setopt (3),
|
|
|
|
|
.BR libcurl-easy (3),
|
|
|
|
|
.BR libcurl-errors (3),
|
|
|
|
|
.BR libcurl-multi (3)
|
