luo980/curl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs/libcurl: expand multi documentation

Browse Source 
curl_multi_init - mention the caches held by the handle

curl_multi_cleanup - mention that the socket callback might be invoked
by this function

Closes #15109
This commit is contained in:
Daniel Stenberg 2024-10-01 15:01:52 +02:00
parent c72cefea0f
commit 85a81d2789
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
2 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/libcurl/curl_multi_cleanup.md
View File

@ -41,6 +41,10 @@ handle is no longer connected to the multi handle
3 - curl_multi_cleanup(3) should be called when all easy handles are
removed
When this function is called, remaining entries in the connection pool held by
the multi handle are shut down, which might trigger calls to the
CURLMOPT_SOCKETFUNCTION(3) callback.
Passing in a NULL pointer in *multi_handle* makes this function return
CURLM_BAD_HANDLE immediately with no other action.

4
docs/libcurl/curl_multi_init.md
View File

@ -34,6 +34,10 @@ all the other multi-functions, sometimes referred to as a multi handle in some
places in the documentation. This init call MUST have a corresponding call to
curl_multi_cleanup(3) when the operation is complete.
By default, several caches are stored in and held by the multi handle: DNS
cache, connection pool, TLS session ID cache and the TLS CA cert cache. All
transfers using the same multi handle share these caches.
# %PROTOCOLS%
# EXAMPLE