Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_SHARE.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, 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: .\"
23: .TH CURLOPT_SHARE 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_SHARE \- specify share handle to use
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SHARE, CURLSH *share);
31: .SH DESCRIPTION
32: Pass a \fIshare\fP handle as a parameter. The share handle must have been
33: created by a previous call to \fIcurl_share_init(3)\fP. Setting this option,
34: will make this curl handle use the data from the shared handle instead of
35: keeping the data to itself. This enables several curl handles to share
36: data. If the curl handles are used simultaneously in multiple threads, you
37: \fBMUST\fP use the locking methods in the share handle. See
38: \fIcurl_share_setopt(3)\fP for details.
39:
40: If you add a share that is set to share cookies, your easy handle will use
41: that cookie cache and get the cookie engine enabled. If you unshare an object
42: that was using cookies (or change to another object that doesn't share
43: cookies), the easy handle will get its cookie engine disabled.
44:
45: Data that the share object is not set to share will be dealt with the usual
46: way, as if no share was used.
47:
48: Set this option to NULL again to stop using that share object.
49: .SH DEFAULT
50: NULL
51: .SH PROTOCOLS
52: All
53: .SH EXAMPLE
54: .nf
55: CURL *curl = curl_easy_init();
56: CURL *curl2 = curl_easy_init(); /* a second handle */
57: if(curl) {
58: CURLSH *shobject = curl_share_init();
59: curl_share_setopt(shobject, CURLSHOPT_SHARE, CURL_LOCK_DATA_COOKIE);
60:
61: curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
62: curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "");
63: curl_easy_setopt(curl, CURLOPT_SHARE, shobject);
64: ret = curl_easy_perform(curl);
65: curl_easy_cleanup(curl);
66:
67: /* the second handle shares cookies from the first */
68: curl_easy_setopt(curl2, CURLOPT_URL, "https://example.com/second");
69: curl_easy_setopt(curl2, CURLOPT_COOKIEFILE, "");
70: curl_easy_setopt(curl2, CURLOPT_SHARE, shobject);
71: ret = curl_easy_perform(curl2);
72: curl_easy_cleanup(curl2);
73:
74: curl_share_cleanup(shobject);
75: }
76: .fi
77: .SH AVAILABILITY
78: Always
79: .SH RETURN VALUE
80: Returns CURLE_OK
81: .SH "SEE ALSO"
82: .BR CURLOPT_COOKIE "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>