| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.TH libcurl-share 3 "8 Aug 2003" "libcurl 7.10.7" "libcurl share interface" |
| 23 |
.SH NAME |
| 24 |
libcurl-share \- how to use the share interface |
| 25 |
.SH DESCRIPTION |
| 26 |
This is an overview on how to use the libcurl share interface in your C |
| 27 |
programs. There are specific man pages for each function mentioned in |
| 28 |
here. |
| 29 |
|
| 30 |
All functions in the share interface are prefixed with curl_share. |
| 31 |
|
| 32 |
.SH "OBJECTIVES" |
| 33 |
The share interface was added to enable sharing of data between curl |
| 34 |
\&"handles". |
| 35 |
.SH "ONE SET OF DATA - MANY TRANSFERS" |
| 36 |
You can have multiple easy handles share data between them. Have them update |
| 37 |
and use the \fBsame\fP cookie database, DNS cache, TLS session cache and/or |
| 38 |
connection cache! This way, each single transfer will take advantage from data |
| 39 |
updates made by the other transfer(s). |
| 40 |
.SH "SHARE OBJECT" |
| 41 |
You create a shared object with \fIcurl_share_init(3)\fP. It returns a handle |
| 42 |
for a newly created one. |
| 43 |
|
| 44 |
You tell the shared object what data you want it to share by using |
| 45 |
\fIcurl_share_setopt(3)\fP. |
| 46 |
|
| 47 |
Since you can use this share from multiple threads, and libcurl has no |
| 48 |
internal thread synchronization, you must provide mutex callbacks if you're |
| 49 |
using this multi-threaded. You set lock and unlock functions with |
| 50 |
\fIcurl_share_setopt(3)\fP too. |
| 51 |
|
| 52 |
Then, you make an easy handle to use this share, you set the |
| 53 |
\fICURLOPT_SHARE(3)\fP option with \fIcurl_easy_setopt(3)\fP, and pass in |
| 54 |
share handle. You can make any number of easy handles share the same share |
| 55 |
handle. |
| 56 |
|
| 57 |
To make an easy handle stop using that particular share, you set |
| 58 |
\fICURLOPT_SHARE(3)\fP to NULL for that easy handle. To make a handle stop |
| 59 |
sharing a particular data, you can \fICURLSHOPT_UNSHARE\fP it. |
| 60 |
|
| 61 |
When you're done using the share, make sure that no easy handle is still using |
| 62 |
it, and call \fIcurl_share_cleanup(3)\fP on the handle. |
| 63 |
.SH "SEE ALSO" |
| 64 |
.BR curl_share_init "(3), " curl_share_setopt "(3), " curl_share_cleanup "(3)" |
| 65 |
.BR libcurl-errors "(3), " libcurl-easy "(3), " libcurl-multi "(3) " |