eefcc1bda4
curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
64 lines
1.9 KiB
Markdown
64 lines
1.9 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: libcurl-share
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- curl_share_cleanup (3)
|
|
- curl_share_init (3)
|
|
- curl_share_setopt (3)
|
|
- libcurl-easy (3)
|
|
- libcurl-errors (3)
|
|
- libcurl-multi (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
libcurl-share - how to use the share interface
|
|
|
|
# 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.
|
|
|
|
# OBJECTIVES
|
|
|
|
The share interface was added to enable sharing of data between curl
|
|
&"handles".
|
|
|
|
# ONE SET OF DATA - MANY TRANSFERS
|
|
|
|
You can have multiple easy handles share data between them. Have them update
|
|
and use the **same** 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).
|
|
|
|
# SHARE OBJECT
|
|
|
|
You create a shared object with curl_share_init(3). It returns a handle
|
|
for a newly created one.
|
|
|
|
You tell the shared object what data you want it to share by using
|
|
curl_share_setopt(3).
|
|
|
|
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
|
|
curl_share_setopt(3) too.
|
|
|
|
Then, you make an easy handle to use this share, you set the
|
|
CURLOPT_SHARE(3) option with curl_easy_setopt(3), 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
|
|
CURLOPT_SHARE(3) to NULL for that easy handle. To make a handle stop
|
|
sharing a particular data, you can CURLSHOPT_UNSHARE(3) it.
|
|
|
|
When you are done using the share, make sure that no easy handle is still using
|
|
it, and call curl_share_cleanup(3) on the handle.
|