| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
- .\" *
- .\" * This software is licensed as described in the file COPYING, which
- .\" * you should have received as part of this distribution. The terms
- .\" * are also available at http://curl.haxx.se/docs/copyright.html.
- .\" *
- .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
- .\" * copies of the Software, and permit persons to whom the Software is
- .\" * furnished to do so, under the terms of the COPYING file.
- .\" *
- .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
- .\" * KIND, either express or implied.
- .\" *
- .\" **************************************************************************
- .TH libcurl-share 3 "8 Aug 2003" "libcurl 7.10.7" "libcurl share interface"
- .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! This
- way, each single transfer will take advantage from data updates made by the
- other transfer(s). The sharing interface, however, does not share active or
- persistent connections between different easy handles.
- .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're
- 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\fP it.
- When you're 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_init "(3), " curl_share_setopt "(3), " curl_share_cleanup "(3)"
|
