master-server/deps/curl/docs/libcurl/opts/CURLSHOPT_SHARE.md

116 lines
3.3 KiB
Markdown
Raw Normal View History

2024-05-15 15:20:32 -04:00
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: CURLSHOPT_SHARE
Section: 3
Source: libcurl
See-also:
- CURLSHOPT_UNSHARE (3)
- curl_share_cleanup (3)
- curl_share_init (3)
- curl_share_setopt (3)
Protocol:
- All
---
# NAME
2023-12-11 20:30:44 -05:00
CURLSHOPT_SHARE - add data to share
2024-05-15 15:20:32 -04:00
# SYNOPSIS
~~~c
2023-12-11 20:30:44 -05:00
#include <curl/curl.h>
CURLSHcode curl_share_setopt(CURLSH *share, CURLSHOPT_SHARE, long type);
2024-05-15 15:20:32 -04:00
~~~
# DESCRIPTION
The *type* parameter specifies what specific data that should be shared
and kept in the share object that was created with curl_share_init(3).
The given *type* must be one of the values described below. You can set
CURLSHOPT_SHARE(3) multiple times with different data arguments to have
2023-12-11 20:30:44 -05:00
the share object share multiple types of data. Unset a type again by setting
2024-05-15 15:20:32 -04:00
CURLSHOPT_UNSHARE(3).
## CURL_LOCK_DATA_COOKIE
2023-12-11 20:30:44 -05:00
Cookie data is shared across the easy handles using this shared object. Note
that this does not activate an easy handle's cookie handling. You can do that
2024-05-15 15:20:32 -04:00
separately by using CURLOPT_COOKIEFILE(3) for example.
## CURL_LOCK_DATA_DNS
2023-12-11 20:30:44 -05:00
Cached DNS hosts are shared across the easy handles using this shared
object. Note that when you use the multi interface, all easy handles added to
the same multi handle share DNS cache by default without using this option.
2024-05-15 15:20:32 -04:00
## CURL_LOCK_DATA_SSL_SESSION
2023-12-11 20:30:44 -05:00
SSL session IDs are shared across the easy handles using this shared
object. This reduces the time spent in the SSL handshake when reconnecting to
the same server. Note SSL session IDs are reused within the same easy handle
by default. Note this symbol was added in 7.10.3 but was not implemented until
7.23.0.
2024-05-15 15:20:32 -04:00
## CURL_LOCK_DATA_CONNECT
2023-12-11 20:30:44 -05:00
Put the connection cache in the share object and make all easy handles using
this share object share the connection cache.
It is not supported to share connections between multiple concurrent threads.
Connections that are used for HTTP/1.1 Pipelining or HTTP/2 multiplexing only
get additional transfers added to them if the existing connection is held by
the same multi or easy handle. libcurl does not support doing HTTP/2 streams
in different threads using a shared connection.
2024-05-15 15:20:32 -04:00
Support for **CURL_LOCK_DATA_CONNECT** was added in 7.57.0, but the symbol
2023-12-11 20:30:44 -05:00
existed before this.
Note that when you use the multi interface, all easy handles added to the same
multi handle shares connection cache by default without using this option.
2024-05-15 15:20:32 -04:00
## CURL_LOCK_DATA_PSL
2023-12-11 20:30:44 -05:00
The Public Suffix List stored in the share object is made available to all
easy handle bound to the later. Since the Public Suffix List is periodically
refreshed, this avoids updates in too many different contexts.
Added in 7.61.0.
Note that when you use the multi interface, all easy handles added to the same
multi handle shares PSL cache by default without using this option.
2024-05-15 15:20:32 -04:00
## CURL_LOCK_DATA_HSTS
2023-12-11 20:30:44 -05:00
The in-memory HSTS cache.
It is not supported to share the HSTS between multiple concurrent threads.
Added in 7.88.0
2024-05-15 15:20:32 -04:00
# EXAMPLE
~~~c
2023-12-11 20:30:44 -05:00
int main(void)
{
CURLSHcode sh;
CURLSH *share = curl_share_init();
sh = curl_share_setopt(share, CURLSHOPT_SHARE, CURL_LOCK_DATA_COOKIE);
if(sh)
2024-05-15 15:20:32 -04:00
printf("Error: %s\n", curl_share_strerror(sh));
2023-12-11 20:30:44 -05:00
}
2024-05-15 15:20:32 -04:00
~~~
# AVAILABILITY
2023-12-11 20:30:44 -05:00
Added in 7.10
2024-05-15 15:20:32 -04:00
# RETURN VALUE
2023-12-11 20:30:44 -05:00
CURLSHE_OK (zero) means that the option was set properly, non-zero means an
2024-05-15 15:20:32 -04:00
error occurred. See libcurl-errors(3) for the full list with
2023-12-11 20:30:44 -05:00
descriptions.